Documentation ¶
Index ¶
- Constants
- type AnalyzeFaceRequest
- type AnalyzeFaceResponse
- type Candidate
- type Client
- func (c *Client) AnalyzeFace(request *AnalyzeFaceRequest) (response *AnalyzeFaceResponse, err error)
- func (c *Client) CompareFace(request *CompareFaceRequest) (response *CompareFaceResponse, err error)
- func (c *Client) CopyPerson(request *CopyPersonRequest) (response *CopyPersonResponse, err error)
- func (c *Client) CreateFace(request *CreateFaceRequest) (response *CreateFaceResponse, err error)
- func (c *Client) CreateGroup(request *CreateGroupRequest) (response *CreateGroupResponse, err error)
- func (c *Client) CreatePerson(request *CreatePersonRequest) (response *CreatePersonResponse, err error)
- func (c *Client) DeleteFace(request *DeleteFaceRequest) (response *DeleteFaceResponse, err error)
- func (c *Client) DeleteGroup(request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)
- func (c *Client) DeletePerson(request *DeletePersonRequest) (response *DeletePersonResponse, err error)
- func (c *Client) DeletePersonFromGroup(request *DeletePersonFromGroupRequest) (response *DeletePersonFromGroupResponse, err error)
- func (c *Client) DetectFace(request *DetectFaceRequest) (response *DetectFaceResponse, err error)
- func (c *Client) DetectLiveFace(request *DetectLiveFaceRequest) (response *DetectLiveFaceResponse, err error)
- func (c *Client) GetGroupInfo(request *GetGroupInfoRequest) (response *GetGroupInfoResponse, err error)
- func (c *Client) GetGroupList(request *GetGroupListRequest) (response *GetGroupListResponse, err error)
- func (c *Client) GetPersonBaseInfo(request *GetPersonBaseInfoRequest) (response *GetPersonBaseInfoResponse, err error)
- func (c *Client) GetPersonGroupInfo(request *GetPersonGroupInfoRequest) (response *GetPersonGroupInfoResponse, err error)
- func (c *Client) GetPersonList(request *GetPersonListRequest) (response *GetPersonListResponse, err error)
- func (c *Client) GetPersonListNum(request *GetPersonListNumRequest) (response *GetPersonListNumResponse, err error)
- func (c *Client) ModifyGroup(request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)
- func (c *Client) ModifyPersonBaseInfo(request *ModifyPersonBaseInfoRequest) (response *ModifyPersonBaseInfoResponse, err error)
- func (c *Client) ModifyPersonGroupInfo(request *ModifyPersonGroupInfoRequest) (response *ModifyPersonGroupInfoResponse, err error)
- func (c *Client) SearchFaces(request *SearchFacesRequest) (response *SearchFacesResponse, err error)
- func (c *Client) SearchFacesReturnsByGroup(request *SearchFacesReturnsByGroupRequest) (response *SearchFacesReturnsByGroupResponse, err error)
- func (c *Client) SearchPersons(request *SearchPersonsRequest) (response *SearchPersonsResponse, err error)
- func (c *Client) SearchPersonsReturnsByGroup(request *SearchPersonsReturnsByGroupRequest) (response *SearchPersonsReturnsByGroupResponse, err error)
- func (c *Client) VerifyFace(request *VerifyFaceRequest) (response *VerifyFaceResponse, err error)
- func (c *Client) VerifyPerson(request *VerifyPersonRequest) (response *VerifyPersonResponse, err error)
- type CompareFaceRequest
- type CompareFaceResponse
- type CopyPersonRequest
- type CopyPersonResponse
- type CreateFaceRequest
- type CreateFaceResponse
- type CreateGroupRequest
- type CreateGroupResponse
- type CreatePersonRequest
- type CreatePersonResponse
- type DeleteFaceRequest
- type DeleteFaceResponse
- type DeleteGroupRequest
- type DeleteGroupResponse
- type DeletePersonFromGroupRequest
- type DeletePersonFromGroupResponse
- type DeletePersonRequest
- type DeletePersonResponse
- type DetectFaceRequest
- type DetectFaceResponse
- type DetectLiveFaceRequest
- type DetectLiveFaceResponse
- type FaceAttributesInfo
- type FaceHairAttributesInfo
- type FaceInfo
- type FaceQualityCompleteness
- type FaceQualityInfo
- type FaceRect
- type FaceShape
- type GetGroupInfoRequest
- type GetGroupInfoResponse
- type GetGroupListRequest
- type GetGroupListResponse
- type GetPersonBaseInfoRequest
- type GetPersonBaseInfoResponse
- type GetPersonGroupInfoRequest
- type GetPersonGroupInfoResponse
- type GetPersonListNumRequest
- type GetPersonListNumResponse
- type GetPersonListRequest
- type GetPersonListResponse
- type GroupCandidate
- type GroupExDescriptionInfo
- type GroupInfo
- type ModifyGroupRequest
- type ModifyGroupResponse
- type ModifyPersonBaseInfoRequest
- type ModifyPersonBaseInfoResponse
- type ModifyPersonGroupInfoRequest
- type ModifyPersonGroupInfoResponse
- type PersonExDescriptionInfo
- type PersonGroupInfo
- type PersonInfo
- type Point
- type Result
- type ResultsReturnsByGroup
- type SearchFacesRequest
- type SearchFacesResponse
- type SearchFacesReturnsByGroupRequest
- type SearchFacesReturnsByGroupResponse
- type SearchPersonsRequest
- type SearchPersonsResponse
- type SearchPersonsReturnsByGroupRequest
- type SearchPersonsReturnsByGroupResponse
- type VerifyFaceRequest
- type VerifyFaceResponse
- type VerifyPersonRequest
- type VerifyPersonResponse
Constants ¶
const ( // This operation cannot be performed across algorithm model versions. FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" // The operations conflict. Do not operate on the same person simultaneously. FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" // Faces cannot be added concurrently. FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" // The custom description field must be unique in the group. FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" // The face image quality does not meet the requirement. FAILEDOPERATION_FACEQUALITYNOTQUALIFIED = "FailedOperation.FaceQualityNotQualified" // The face frame size is smaller than the `MinFaceSize` value, and the face is filtered out. FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" // The current group is being deleted. Please wait. FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" // The ID of the corresponding person is already in the group. FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" // The ID of the corresponding person is not in the group. FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" // Image decoding failed. FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" // An error occurred while downloading the image. FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" // Face detection failed. FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" // The image resolution is too high. FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" // The image short edge resolution is smaller than 64. FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" // The size of the Base64-encoded image cannot exceed 5 MB. FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" // The request frequency exceeds the limit. FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" // The backend service timed out. FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" // The number of faces searched for exceeds the limit. FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" // The algorithm service is exceptional. Please retry. FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" // Internal error. INTERNALERROR = "InternalError" // Invalid parameter. INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" // The number of faces in the account exceeds the limit. INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" // The number of faces to be deleted exceeds the limit. Every person must have at least one face image. INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" // Invalid `FaceMatchThreshold` parameter. INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" // The algorithm model version is invalid. INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" // The array length of the group's custom description fields exceeds the limit. Up to 5 fields can be created. INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" // The name of the group's custom description field must be unique. INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" // The name of the group's custom description field contains invalid characters. It can contain only letters, `-`, `_`, and digits. INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" // The name of the group's custom description field exceeds the length limit. INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" // The number of faces in the group exceeds the limit. INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" // The group ID already exists. It must be unique. INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" // The group ID contains invalid characters. It can contain only letters, digits, and special symbols (-%@#&_). INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" // The group ID does not exist. INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" // The corresponding group ID does not exist. INVALIDPARAMETERVALUE_GROUPIDNOTEXISTS = "InvalidParameterValue.GroupIdNotExists" // The group ID exceeds the length limit. INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" // The list of groups passed in exceeds the limit. INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" // The group name already exists. It must be unique. INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" // The group name contains invalid characters. It can contain only letters, `-`, `_`, and digits. INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" // The group name exceeds the length limit. INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" // The number of groups exceeds the limit. If you need more, please contact us. INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" // The number of groups exceeds the limit. One person can be added to up to 100 groups. INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" // The group remarks field contains invalid characters. It can contain only letters, `-`, `_`, and digits. INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" // The group remarks field exceeds the length limit. INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" // Empty image. INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" // Empty image. INVALIDPARAMETERVALUE_IMAGEEMPTYERROR = "InvalidParameterValue.ImageEmptyError" // The number of returned results exceeds the limit. INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" // There are no faces in the specified group. INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" // There are no faces in the image. INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" // The starting number is too large. Please check the length of the array to be requested. INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" // The array length of the person's custom description fields exceeds the limit. Up to 5 fields are allowed. INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" // The name of the person's custom description field must be unique. INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" // The name of the person's custom description field contains invalid characters. It can contain only letters, `-`, `_`, and digits. INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" // The name of the person's custom description field exceeds the length limit. INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" // The ID of the corresponding person is already in the group. INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" // The number of face images for the person exceeds the limit. One person can have up to 5 face images. INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" // An error occurred while setting person gender. 0: empty; 1: male; 2: female. INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" // The person ID already exists. It must be unique. INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" // The person ID contains invalid characters. It can contain only letters, digits, and -%@#&_. INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" // The person ID does not exist. INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" // The person ID field exceeds the length limit. INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" // The person name contains invalid characters. It can contain only letters, `-`, `_`, and digits. INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" // The person name exceeds the length limit. INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" // Invalid `QualityControl` parameter. INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" // The number of persons searched for exceeds the limit. INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" // Invalid `UniquePersonControl` parameter. INVALIDPARAMETERVALUE_UNIQUEPERSONCONTROLILLEGAL = "InvalidParameterValue.UniquePersonControlIllegal" // This operation is not supported by algorithm model v2.0 or below. INVALIDPARAMETERVALUE_UNSUPPORTEDGROUPFACEMODELVERSION = "InvalidParameterValue.UnsupportedGroupFaceModelVersion" // Up to four faces can be uploaded at a time. INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" // Invalid URL format. INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" // The number of faces exceeds the limit. LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" // A required parameter is empty. MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" // The account is in arrears. RESOURCEUNAVAILABLE_CHARGESTATUSEXCEPTION = "ResourceUnavailable.ChargeStatusException" // The resource is being shipped. RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" // The account is frozen. RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" // Failed to get the authentication information. RESOURCEUNAVAILABLE_GETAUTHINFOERROR = "ResourceUnavailable.GetAuthInfoError" // The account is in arrears. RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" // Insufficient balance. RESOURCEUNAVAILABLE_LOWBALANCE = "ResourceUnavailable.LowBalance" // The billing status is unknown. Please check whether the service has been activated in the console. RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" // The service is not activated. RESOURCEUNAVAILABLE_NOTREADY = "ResourceUnavailable.NotReady" // The resource has been repossessed. RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" // The service has been suspended for the account. RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" // The billing status is unknown. RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" // The billing status is exceptional. RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" // Unknown method name. UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod" )
const APIVersion = "2020-03-03"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalyzeFaceRequest ¶
type AnalyzeFaceRequest struct { *tchttp.BaseRequest // Detection mode. 0: detect all faces that appear; 1: detect the largest face. Default value: 0. The facial feature localization information (facial keypoints) of up to 10 faces can be returned. Mode *uint64 `json:"Mode,omitempty" name:"Mode"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Algorithm model version used by the Face Recognition service. Valid values: 2.0, 3.0. // This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API previously, `2.0` will be used by default. // Different algorithm model versions correspond to different face recognition algorithms. The new version has a better overall effect than the legacy version and is thus recommended. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewAnalyzeFaceRequest ¶
func NewAnalyzeFaceRequest() (request *AnalyzeFaceRequest)
func (*AnalyzeFaceRequest) FromJsonString ¶
func (r *AnalyzeFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AnalyzeFaceRequest) ToJsonString ¶
func (r *AnalyzeFaceRequest) ToJsonString() string
type AnalyzeFaceResponse ¶
type AnalyzeFaceResponse struct { *tchttp.BaseResponse Response *struct { // Width of requested image. ImageWidth *uint64 `json:"ImageWidth,omitempty" name:"ImageWidth"` // Height of requested image. ImageHeight *uint64 `json:"ImageHeight,omitempty" name:"ImageHeight"` // Specific information of facial feature localization (facial keypoints). FaceShapeSet []*FaceShape `json:"FaceShapeSet,omitempty" name:"FaceShapeSet"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAnalyzeFaceResponse ¶
func NewAnalyzeFaceResponse() (response *AnalyzeFaceResponse)
func (*AnalyzeFaceResponse) FromJsonString ¶
func (r *AnalyzeFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AnalyzeFaceResponse) ToJsonString ¶
func (r *AnalyzeFaceResponse) ToJsonString() string
type Candidate ¶
type Candidate struct { // Person ID PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Face ID FaceId *string `json:"FaceId,omitempty" name:"FaceId"` // Match score of candidate. // // In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively; // In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively; // In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively. // // Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90. Score *float64 `json:"Score,omitempty" name:"Score"` // Person name // Note: this field may return null, indicating that no valid values can be obtained. PersonName *string `json:"PersonName,omitempty" name:"PersonName"` // Person gender // Note: this field may return null, indicating that no valid values can be obtained. Gender *int64 `json:"Gender,omitempty" name:"Gender"` // List of groups containing this person and their description fields // Note: this field may return null, indicating that no valid values can be obtained. PersonGroupInfos []*PersonGroupInfo `json:"PersonGroupInfos,omitempty" name:"PersonGroupInfos"` }
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AnalyzeFace ¶
func (c *Client) AnalyzeFace(request *AnalyzeFaceRequest) (response *AnalyzeFaceResponse, err error)
AnalyzeFace This API is used to perform facial feature localization (aka facial keypoint localization) on a given image and calculate 90 facial keypoints that make up the contour of the face, including eyebrows (8 points on the left and 8 on the right), eyes (8 points on the left and 8 on the right), nose (13 points), mouth (22 points), face contour (21 points), and eyeballs or pupils (2 points).
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) CompareFace ¶
func (c *Client) CompareFace(request *CompareFaceRequest) (response *CompareFaceResponse, err error)
CompareFace This API is used to calculate the similarity of faces in two images and return the face similarity score.
If you need to judge "whether the person in the image is someone specified" in scenarios such as face login, i.e., checking whether the person in a given image is someone with a known identity, we recommend using the [VerifyFace](https://intl.cloud.tencent.com/document/product/867/44983?from_cn_redirect=1) or [VerifyPerson](https://intl.cloud.tencent.com/document/product/867/44982?from_cn_redirect=1) API.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACEQUALITYNOTQUALIFIED = "FailedOperation.FaceQualityNotQualified" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) CopyPerson ¶
func (c *Client) CopyPerson(request *CopyPersonRequest) (response *CopyPersonResponse, err error)
CopyPerson This API is used to copy a person in a group to another group (without copying the description). One person can exist in up to 100 groups at the same time.
>
- Note: in the case that the version of the algorithm model was 2.0 when the person was created, the copy operation will fail if the target group is not of algorithm model 2.0.
error code that may be returned:
FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) CreateFace ¶
func (c *Client) CreateFace(request *CreateFaceRequest) (response *CreateFaceResponse, err error)
CreateFace This API is used to add a set of face images to a person. One person can have up to 5 images. If a person exists in multiple groups, the images will be added to all those groups for the person.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) CreateGroup ¶
func (c *Client) CreateGroup(request *CreateGroupRequest) (response *CreateGroupResponse, err error)
CreateGroup This API is used to create an empty group. If the group already exists, an error will be returned.
Custom description fields can be created as needed to describe persons in the group.
A maximum of 100,000 groups or 50 million faces can be created under one `APPID`.
The maximum number of faces that can be included in one group varies by algorithm model version (`FaceModelVersion`), which is 1 million for v2.0 or 3 million for v3.0.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_LOWBALANCE = "ResourceUnavailable.LowBalance" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) CreatePerson ¶
func (c *Client) CreatePerson(request *CreatePersonRequest) (response *CreatePersonResponse, err error)
CreatePerson This API is used to create a person and add face, name, gender, and other related information.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACEQUALITYNOTQUALIFIED = "FailedOperation.FaceQualityNotQualified" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UNIQUEPERSONCONTROLILLEGAL = "InvalidParameterValue.UniquePersonControlIllegal" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DeleteFace ¶
func (c *Client) DeleteFace(request *DeleteFaceRequest) (response *DeleteFaceResponse, err error)
DeleteFace This API is used to delete the face images of a person. If the person has only one face image, an error will be returned.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)
DeleteGroup This API is used to delete a group and all persons in it. Meanwhile, all face information corresponding to the persons will be deleted. If a person exists in multiple groups at the same time, deleting a group will not delete the person, but the custom description field information in the group will be deleted. Custom description field information in other groups will not be affected.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DeletePerson ¶
func (c *Client) DeletePerson(request *DeletePersonRequest) (response *DeletePersonResponse, err error)
DeletePerson This API is used to delete a person from all groups. Meanwhile, all face information of the person will be deleted.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DeletePersonFromGroup ¶
func (c *Client) DeletePersonFromGroup(request *DeletePersonFromGroupRequest) (response *DeletePersonFromGroupResponse, err error)
DeletePersonFromGroup This API is used to remove a person from a specified group. This operation only affects the group. If the person exists only in the group, the person will be deleted, and all face information of the person will also be deleted.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_CREATEFACECONCURRENT = "FailedOperation.CreateFaceConcurrent" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DetectFace ¶
func (c *Client) DetectFace(request *DetectFaceRequest) (response *DetectFaceResponse, err error)
DetectFace This API is used to detect the position, attributes, and quality information of a face in the given image. The position information includes (x, y, w, h); the face attributes include gender, age, expression, beauty, glass, hair, mask, and pose (pitch, roll, yaw); and the face quality information includes the overall quality score, sharpness, brightness, and completeness.
The face quality information is mainly used to evaluate the quality of the input face image. When using the Face Recognition service, we recommend evaluating the quality of the input face image first to improve the effects of subsequent processing. Application scenarios of this feature include:
1. [Creating](https://intl.cloud.tencent.com/document/product/867/45014?from_cn_redirect=1)/[Adding](https://intl.cloud.tencent.com/document/product/867/45016?from_cn_redirect=1) a person in a group: this is to ensure the quality of the face information to facilitate subsequent processing.
2. [Face search](https://intl.cloud.tencent.com/document/product/867/44994?from_cn_redirect=1): this is to ensure the quality of the input image to quickly find the corresponding person.
3. [Face verification](https://intl.cloud.tencent.com/document/product/867/44983?from_cn_redirect=1): this is to ensure the quality of the face information to avoid cases where the verification incorrectly fails.
4. Face fusion: this is to ensure the quality of the uploaded face images to improve the fusion effect.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) DetectLiveFace ¶
func (c *Client) DetectLiveFace(request *DetectLiveFaceRequest) (response *DetectLiveFaceResponse, err error)
DetectLiveFace This API is used to detect the liveness of a user with a user-uploaded image. Its difference from video-based liveness detection lies in that the user does not need to speak, shake their head, or wink for detection.
Image-based liveness detection is suitable for scenarios where the image is a selfie or the requirement for attack defense is not high. If you have a higher security requirement for liveness detection, please use [FaceID](https://intl.cloud.tencent.com/product/faceid?from_cn_redirect=1).
>
- The aspect ratio of the image should be close to 3:4 (width:height); otherwise, the score returned for the image will be meaningless. This API is suitable for selfie scenarios, and the score returned in other scenarios will be meaningless.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMODELVERSIONILLEGAL = "InvalidParameterValue.FaceModelVersionIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) GetGroupInfo ¶
func (c *Client) GetGroupInfo(request *GetGroupInfoRequest) (response *GetGroupInfoResponse, err error)
GetGroupInfo This API is used to get the group information.
error code that may be returned:
FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException"
func (*Client) GetGroupList ¶
func (c *Client) GetGroupList(request *GetGroupListRequest) (response *GetGroupListResponse, err error)
GetGroupList This API is used to get the list of groups.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) GetPersonBaseInfo ¶
func (c *Client) GetPersonBaseInfo(request *GetPersonBaseInfoRequest) (response *GetPersonBaseInfoResponse, err error)
GetPersonBaseInfo This API is used to get the information of a specified person, including name, gender, face, etc.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) GetPersonGroupInfo ¶
func (c *Client) GetPersonGroupInfo(request *GetPersonGroupInfoRequest) (response *GetPersonGroupInfoResponse, err error)
GetPersonGroupInfo This API is used to get the information of a specified person, including group, description, etc.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) GetPersonList ¶
func (c *Client) GetPersonList(request *GetPersonListRequest) (response *GetPersonListResponse, err error)
GetPersonList This API is used to get the list of persons in a specified group.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) GetPersonListNum ¶
func (c *Client) GetPersonListNum(request *GetPersonListNumRequest) (response *GetPersonListNumResponse, err error)
GetPersonListNum This API is used to get the number of persons in a specified group.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) ModifyGroup ¶
func (c *Client) ModifyGroup(request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)
ModifyGroup This API is used to modify the name, tag, and custom description field of a group.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) ModifyPersonBaseInfo ¶
func (c *Client) ModifyPersonBaseInfo(request *ModifyPersonBaseInfoRequest) (response *ModifyPersonBaseInfoResponse, err error)
ModifyPersonBaseInfo This API is used to modify the information of a person, including name, gender, etc. The changes of person name and gender will be synced to all the groups that contain the person.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) ModifyPersonGroupInfo ¶
func (c *Client) ModifyPersonGroupInfo(request *ModifyPersonGroupInfoRequest) (response *ModifyPersonGroupInfoResponse, err error)
ModifyPersonGroupInfo This API is used to modify the description of a specified person in a group.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) SearchFaces ¶
func (c *Client) SearchFaces(request *SearchFacesRequest) (response *SearchFacesResponse, err error)
SearchFaces This API is used to recognize top K persons in one or more groups who are similar to the person in a given image and rank the similarity in a descending order.
Up to 10 faces in an image can be recognized at a time, and up to 100 groups can be searched in at a time.
The maximum number of faces in groups that can be searched for at a time is subject to the group's algorithm model version (`FaceModelVersion`), which is 1 million for v2.0 or 3 million for v3.0.
This API recognizes each face image of a person as an independent one. By contrast, the [SearchPersons](https://intl.cloud.tencent.com/document/product/867/44992?from_cn_redirect=1) and [SearchPersonsReturnsByGroup](https://intl.cloud.tencent.com/document/product/867/44991?from_cn_redirect=1) APIs fuse the features of all face images of a person; for example, if a person has 4 face images, they will fuse the features of the 4 face images and generate the summarized facial features of the person to make the search more accurate.
This API should be used together with [Group Management APIs](https://intl.cloud.tencent.com/document/product/867/45015?from_cn_redirect=1).
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) SearchFacesReturnsByGroup ¶
func (c *Client) SearchFacesReturnsByGroup(request *SearchFacesReturnsByGroupRequest) (response *SearchFacesReturnsByGroupResponse, err error)
SearchFacesReturnsByGroup This API is used to recognize top K persons in one or more groups who are similar to the person in a given image, display the results **by group**, and rank the similarity within each group in a descending order.
Up to 10 faces in the image can be recognized at a time, and cross-group search is supported.
The maximum number of faces in groups that can be searched for at a time is subject to the group's algorithm model version (`FaceModelVersion`), which is 1 million for v2.0 or 3 million for v3.0.
This API recognizes each face image of a person as an independent one. By contrast, the [SearchPersons](https://intl.cloud.tencent.com/document/product/867/44992?from_cn_redirect=1) and [SearchPersonsReturnsByGroup](https://intl.cloud.tencent.com/document/product/867/44991?from_cn_redirect=1) APIs fuse the features of all face images of a person; for example, if a person has 4 face images, they will fuse the features of the 4 face images and generate the summarized facial features of the person to make the search more accurate.
This API should be used together with [Group Management APIs](https://intl.cloud.tencent.com/document/product/867/45015?from_cn_redirect=1).
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) SearchPersons ¶
func (c *Client) SearchPersons(request *SearchPersonsRequest) (response *SearchPersonsResponse, err error)
SearchPersons This API is used to recognize top K persons in one or more groups who are similar to the person in a given image and rank the similarity in a descending order.
Up to 10 faces in an image can be recognized at a time, and up to 100 groups can be searched in at a time.
The maximum number of faces in groups that can be searched for at a time is subject to the group's algorithm model version (`FaceModelVersion`), which is 1 million for v2.0 or 3 million for v3.0.
This API fuses the features of all face images of a person; for example, if a person has 4 face images, it will fuse the features of the 4 face images and generate the summarized facial features of the person to make the person search (i.e., judging whether the face image to be recognized is of a specified person) more accurate. By contrast, the [SearchFaces](https://intl.cloud.tencent.com/document/product/867/44994?from_cn_redirect=1) and [SearchFacesReturnsByGroup](https://intl.cloud.tencent.com/document/product/867/44993?from_cn_redirect=1) APIs recognize each face image of a person as an independent one for search.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
- This feature is available only to groups whose algorithm model version (`FaceModelVersion`) is 3.0.
error code that may be returned:
FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_IMAGEEMPTYERROR = "InvalidParameterValue.ImageEmptyError" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UNSUPPORTEDGROUPFACEMODELVERSION = "InvalidParameterValue.UnsupportedGroupFaceModelVersion" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_CHARGESTATUSEXCEPTION = "ResourceUnavailable.ChargeStatusException" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_GETAUTHINFOERROR = "ResourceUnavailable.GetAuthInfoError" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_LOWBALANCE = "ResourceUnavailable.LowBalance" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_NOTREADY = "ResourceUnavailable.NotReady" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) SearchPersonsReturnsByGroup ¶
func (c *Client) SearchPersonsReturnsByGroup(request *SearchPersonsReturnsByGroupRequest) (response *SearchPersonsReturnsByGroupResponse, err error)
SearchPersonsReturnsByGroup This API is used to recognize top K persons in one or more groups who are similar to the person in a given image, display the results **by group**, and rank the similarity within each group in a descending order.
Up to 10 faces in the image can be recognized at a time, and cross-group search is supported.
The maximum number of faces in groups that can be searched for at a time is subject to the group's algorithm model version (`FaceModelVersion`), which is 1 million for v2.0 or 3 million for v3.0.
This API fuses the features of all face images of a person; for example, if a person has 4 face images, it will fuse the features of the 4 face images and generate the summarized facial features of the person to make the person search (i.e., judging whether the face image to be recognized is of a specified person) more accurate. By contrast, the [SearchFaces](https://intl.cloud.tencent.com/document/product/867/44994?from_cn_redirect=1) and [SearchFacesReturnsByGroup](https://intl.cloud.tencent.com/document/product/867/44993?from_cn_redirect=1) APIs recognize each face image of a person as an independent one for search.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
- This feature is available only to groups whose algorithm model version (`FaceModelVersion`) is 3.0.
error code that may be returned:
FAILEDOPERATION_ACROSSVERSIONSERROR = "FailedOperation.AcrossVersionsError" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_FACEMATCHTHRESHOLDILLEGAL = "InvalidParameterValue.FaceMatchThresholdIllegal" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDNOTEXISTS = "InvalidParameterValue.GroupIdNotExists" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UNSUPPORTEDGROUPFACEMODELVERSION = "InvalidParameterValue.UnsupportedGroupFaceModelVersion" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_CHARGESTATUSEXCEPTION = "ResourceUnavailable.ChargeStatusException" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_LOWBALANCE = "ResourceUnavailable.LowBalance" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_NOTREADY = "ResourceUnavailable.NotReady" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) VerifyFace ¶
func (c *Client) VerifyFace(request *VerifyFaceRequest) (response *VerifyFaceResponse, err error)
VerifyFace This API is used to judge whether a person in an image corresponds to a given `PersonId`. For more information on `PersonId`, please see [Group Management APIs](https://intl.cloud.tencent.com/document/product/867/45015?from_cn_redirect=1).
The `VerifyFace` API judges whether a person is someone specified whose information is stored in a group, and the "someone" may have multiple face images. By contrast, the [CompareFace](https://intl.cloud.tencent.com/document/product/867/44987?from_cn_redirect=1) API judges the similarity between two faces.
This API recognizes each face image of a person as an independent one. By contrast, the [VerifyPerson](https://intl.cloud.tencent.com/document/product/867/44982?from_cn_redirect=1) API fuses the features of all face images of a person; for example, if a person has 4 face images, it will fuse the features of the 4 face images and generate the summarized facial features of the person to make the person verification (i.e., judging whether the face image to be recognized is of a specified person) more accurate.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
error code that may be returned:
FAILEDOPERATION_CONFLICTOPERATION = "FailedOperation.ConflictOperation" FAILEDOPERATION_DUPLICATEDGROUPDESCRIPTION = "FailedOperation.DuplicatedGroupDescription" FAILEDOPERATION_FACEQUALITYNOTQUALIFIED = "FailedOperation.FaceQualityNotQualified" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_GROUPINDELETEDSTATE = "FailedOperation.GroupInDeletedState" FAILEDOPERATION_GROUPPERSONMAPEXIST = "FailedOperation.GroupPersonMapExist" FAILEDOPERATION_GROUPPERSONMAPNOTEXIST = "FailedOperation.GroupPersonMapNotExist" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SEARCHFACESEXCEED = "FailedOperation.SearchFacesExceed" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_ACCOUNTFACENUMEXCEED = "InvalidParameterValue.AccountFaceNumExceed" INVALIDPARAMETERVALUE_DELETEFACENUMEXCEED = "InvalidParameterValue.DeleteFaceNumExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSEXCEED = "InvalidParameterValue.GroupExDescriptionsExceed" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.GroupExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.GroupExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_GROUPEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.GroupExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_GROUPFACENUMEXCEED = "InvalidParameterValue.GroupFaceNumExceed" INVALIDPARAMETERVALUE_GROUPIDALREADYEXIST = "InvalidParameterValue.GroupIdAlreadyExist" INVALIDPARAMETERVALUE_GROUPIDILLEGAL = "InvalidParameterValue.GroupIdIllegal" INVALIDPARAMETERVALUE_GROUPIDNOTEXIST = "InvalidParameterValue.GroupIdNotExist" INVALIDPARAMETERVALUE_GROUPIDTOOLONG = "InvalidParameterValue.GroupIdTooLong" INVALIDPARAMETERVALUE_GROUPIDSEXCEED = "InvalidParameterValue.GroupIdsExceed" INVALIDPARAMETERVALUE_GROUPNAMEALREADYEXIST = "InvalidParameterValue.GroupNameAlreadyExist" INVALIDPARAMETERVALUE_GROUPNAMEILLEGAL = "InvalidParameterValue.GroupNameIllegal" INVALIDPARAMETERVALUE_GROUPNAMETOOLONG = "InvalidParameterValue.GroupNameTooLong" INVALIDPARAMETERVALUE_GROUPNUMEXCEED = "InvalidParameterValue.GroupNumExceed" INVALIDPARAMETERVALUE_GROUPNUMPERPERSONEXCEED = "InvalidParameterValue.GroupNumPerPersonExceed" INVALIDPARAMETERVALUE_GROUPTAGILLEGAL = "InvalidParameterValue.GroupTagIllegal" INVALIDPARAMETERVALUE_GROUPTAGTOOLONG = "InvalidParameterValue.GroupTagTooLong" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_LIMITEXCEED = "InvalidParameterValue.LimitExceed" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_OFFSETEXCEED = "InvalidParameterValue.OffsetExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONINFOSEXCEED = "InvalidParameterValue.PersonExDescriptionInfosExceed" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEIDENTICAL = "InvalidParameterValue.PersonExDescriptionsNameIdentical" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMEILLEGAL = "InvalidParameterValue.PersonExDescriptionsNameIllegal" INVALIDPARAMETERVALUE_PERSONEXDESCRIPTIONSNAMETOOLONG = "InvalidParameterValue.PersonExDescriptionsNameTooLong" INVALIDPARAMETERVALUE_PERSONEXISTINGROUP = "InvalidParameterValue.PersonExistInGroup" INVALIDPARAMETERVALUE_PERSONFACENUMEXCEED = "InvalidParameterValue.PersonFaceNumExceed" INVALIDPARAMETERVALUE_PERSONGENDERILLEGAL = "InvalidParameterValue.PersonGenderIllegal" INVALIDPARAMETERVALUE_PERSONIDALREADYEXIST = "InvalidParameterValue.PersonIdAlreadyExist" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_PERSONIDTOOLONG = "InvalidParameterValue.PersonIdTooLong" INVALIDPARAMETERVALUE_PERSONNAMEILLEGAL = "InvalidParameterValue.PersonNameIllegal" INVALIDPARAMETERVALUE_PERSONNAMETOOLONG = "InvalidParameterValue.PersonNameTooLong" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_SEARCHPERSONSEXCEED = "InvalidParameterValue.SearchPersonsExceed" INVALIDPARAMETERVALUE_UPLOADFACENUMEXCEED = "InvalidParameterValue.UploadFaceNumExceed" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" LIMITEXCEEDED_ERRORFACENUMEXCEED = "LimitExceeded.ErrorFaceNumExceed" MISSINGPARAMETER_ERRORPARAMETEREMPTY = "MissingParameter.ErrorParameterEmpty" RESOURCEUNAVAILABLE_DELIVERING = "ResourceUnavailable.Delivering" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_RECOVER = "ResourceUnavailable.Recover" RESOURCEUNAVAILABLE_STOPUSING = "ResourceUnavailable.StopUsing" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
func (*Client) VerifyPerson ¶
func (c *Client) VerifyPerson(request *VerifyPersonRequest) (response *VerifyPersonResponse, err error)
VerifyPerson This API is used to judge whether a person in an image corresponds to a given `PersonId`. For more information on `PersonId`, please see [Group Management APIs](https://intl.cloud.tencent.com/document/product/867/45015?from_cn_redirect=1).
This API fuses the features of all face images of a person; for example, if a person has 4 face images, it will fuse the features of the 4 face images and generate the summarized facial features of the person to make the person verification (i.e., judging whether the face image to be recognized is of a specified person) more accurate.
The face verification APIs judge whether a person is someone specified whose information is stored in a group, and the "someone" may have multiple face images. By contrast, the face comparison APIs judge the similarity between two faces.
>
- Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the `SignatureMethod` parameter to `TC3-HMAC-SHA256`.
- This feature is available only to groups whose algorithm model version (`FaceModelVersion`) is 3.0.
error code that may be returned:
FAILEDOPERATION_FACEQUALITYNOTQUALIFIED = "FailedOperation.FaceQualityNotQualified" FAILEDOPERATION_FACESIZETOOSMALL = "FailedOperation.FaceSizeTooSmall" FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed" FAILEDOPERATION_IMAGEDOWNLOADERROR = "FailedOperation.ImageDownloadError" FAILEDOPERATION_IMAGEFACEDETECTFAILED = "FailedOperation.ImageFacedetectFailed" FAILEDOPERATION_IMAGERESOLUTIONEXCEED = "FailedOperation.ImageResolutionExceed" FAILEDOPERATION_IMAGERESOLUTIONTOOSMALL = "FailedOperation.ImageResolutionTooSmall" FAILEDOPERATION_IMAGESIZEEXCEED = "FailedOperation.ImageSizeExceed" FAILEDOPERATION_REQUESTLIMITEXCEEDED = "FailedOperation.RequestLimitExceeded" FAILEDOPERATION_REQUESTTIMEOUT = "FailedOperation.RequestTimeout" FAILEDOPERATION_SERVERERROR = "FailedOperation.ServerError" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter" INVALIDPARAMETERVALUE_IMAGEEMPTY = "InvalidParameterValue.ImageEmpty" INVALIDPARAMETERVALUE_NOFACEINGROUPS = "InvalidParameterValue.NoFaceInGroups" INVALIDPARAMETERVALUE_NOFACEINPHOTO = "InvalidParameterValue.NoFaceInPhoto" INVALIDPARAMETERVALUE_PERSONIDILLEGAL = "InvalidParameterValue.PersonIdIllegal" INVALIDPARAMETERVALUE_PERSONIDNOTEXIST = "InvalidParameterValue.PersonIdNotExist" INVALIDPARAMETERVALUE_QUALITYCONTROLILLEGAL = "InvalidParameterValue.QualityControlIllegal" INVALIDPARAMETERVALUE_UNSUPPORTEDGROUPFACEMODELVERSION = "InvalidParameterValue.UnsupportedGroupFaceModelVersion" INVALIDPARAMETERVALUE_URLILLEGAL = "InvalidParameterValue.UrlIllegal" RESOURCEUNAVAILABLE_CHARGESTATUSEXCEPTION = "ResourceUnavailable.ChargeStatusException" RESOURCEUNAVAILABLE_FREEZE = "ResourceUnavailable.Freeze" RESOURCEUNAVAILABLE_GETAUTHINFOERROR = "ResourceUnavailable.GetAuthInfoError" RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears" RESOURCEUNAVAILABLE_LOWBALANCE = "ResourceUnavailable.LowBalance" RESOURCEUNAVAILABLE_NOTEXIST = "ResourceUnavailable.NotExist" RESOURCEUNAVAILABLE_NOTREADY = "ResourceUnavailable.NotReady" RESOURCEUNAVAILABLE_UNKNOWNSTATUS = "ResourceUnavailable.UnknownStatus" RESOURCESSOLDOUT_CHARGESTATUSEXCEPTION = "ResourcesSoldOut.ChargeStatusException" UNSUPPORTEDOPERATION_UNKNOWMETHOD = "UnsupportedOperation.UnknowMethod"
type CompareFaceRequest ¶
type CompareFaceRequest struct { *tchttp.BaseRequest // Base64-encoded data of image A, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. ImageA *string `json:"ImageA,omitempty" name:"ImageA"` // Base64-encoded data of image B, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. ImageB *string `json:"ImageB,omitempty" name:"ImageB"` // URL of image A. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` of image A must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. UrlA *string `json:"UrlA,omitempty" name:"UrlA"` // URL of image B. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` of image B must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. UrlB *string `json:"UrlB,omitempty" name:"UrlB"` // Algorithm model version used by the Face Recognition service. Valid values: 2.0, 3.0. // This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API previously, `2.0` will be used by default. // Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is thus recommended. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewCompareFaceRequest ¶
func NewCompareFaceRequest() (request *CompareFaceRequest)
func (*CompareFaceRequest) FromJsonString ¶
func (r *CompareFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CompareFaceRequest) ToJsonString ¶
func (r *CompareFaceRequest) ToJsonString() string
type CompareFaceResponse ¶
type CompareFaceResponse struct { *tchttp.BaseResponse Response *struct { // Face similarity score between two images. // The returned similarity score varies by algorithm version. // If you need to verify whether the faces in the two images are the same person, then the 0.1%, 0.01%, and 0.001% FARs on v3.0 correspond to scores of 40, 50, and 60, respectively. Generally, if the score is above 50, it can be judged that they are the same person. // The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90, respectively. Generally, if the score is above 80, it can be judged that they are the same person. // If you need to verify whether the faces in the two images are the same person, we recommend using the `VerifyFace` API. Score *float64 `json:"Score,omitempty" name:"Score"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCompareFaceResponse ¶
func NewCompareFaceResponse() (response *CompareFaceResponse)
func (*CompareFaceResponse) FromJsonString ¶
func (r *CompareFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CompareFaceResponse) ToJsonString ¶
func (r *CompareFaceResponse) ToJsonString() string
type CopyPersonRequest ¶
type CopyPersonRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // List of groups to join. The array element value is the `GroupId` in the `CreateGroup` API. GroupIds []*string `json:"GroupIds,omitempty" name:"GroupIds"` }
func NewCopyPersonRequest ¶
func NewCopyPersonRequest() (request *CopyPersonRequest)
func (*CopyPersonRequest) FromJsonString ¶
func (r *CopyPersonRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CopyPersonRequest) ToJsonString ¶
func (r *CopyPersonRequest) ToJsonString() string
type CopyPersonResponse ¶
type CopyPersonResponse struct { *tchttp.BaseResponse Response *struct { // Number of groups successfully added to. SucGroupNum *uint64 `json:"SucGroupNum,omitempty" name:"SucGroupNum"` // List of groups successfully added to. SucGroupIds []*string `json:"SucGroupIds,omitempty" name:"SucGroupIds"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCopyPersonResponse ¶
func NewCopyPersonResponse() (response *CopyPersonResponse)
func (*CopyPersonResponse) FromJsonString ¶
func (r *CopyPersonResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CopyPersonResponse) ToJsonString ¶
func (r *CopyPersonResponse) ToJsonString() string
type CreateFaceRequest ¶
type CreateFaceRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // A person can have up to 5 face images. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Images []*string `json:"Images,omitempty" name:"Images"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. // A person can have up to 5 face images. // If there are multiple faces in the image, only the face with the largest size will be selected. Urls []*string `json:"Urls,omitempty" name:"Urls"` // Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully. // Default value: 60. Value range: [0,100]. FaceMatchThreshold *float64 `json:"FaceMatchThreshold,omitempty" name:"FaceMatchThreshold"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewCreateFaceRequest ¶
func NewCreateFaceRequest() (request *CreateFaceRequest)
func (*CreateFaceRequest) FromJsonString ¶
func (r *CreateFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateFaceRequest) ToJsonString ¶
func (r *CreateFaceRequest) ToJsonString() string
type CreateFaceResponse ¶
type CreateFaceResponse struct { *tchttp.BaseResponse Response *struct { // Number of successfully added faces SucFaceNum *uint64 `json:"SucFaceNum,omitempty" name:"SucFaceNum"` // List of IDs of successfully added faces SucFaceIds []*string `json:"SucFaceIds,omitempty" name:"SucFaceIds"` // Adding result for each face image. -1101: no face detected; -1102: image decoding failed; // -1601: the image quality control requirement is not met; -1604: the face similarity is not above `FaceMatchThreshold`. // Other non-zero values: algorithm service exception. // The order of `RetCode` values is the same as the order of `Images` or `Urls` in the input parameter. RetCode []*int64 `json:"RetCode,omitempty" name:"RetCode"` // Indexes of successfully added faces. The order of indexes is the same as the order of `Images` or `Urls` in the input parameter. // For example, if there are 3 URLs in `Urls`, and the second URL fails, then the value of `SucIndexes` will be [0,2]. SucIndexes []*uint64 `json:"SucIndexes,omitempty" name:"SucIndexes"` // Frame positions of successfully added faces. The order is the same as the order of `Images` or `Urls` in the input parameter. SucFaceRects []*FaceRect `json:"SucFaceRects,omitempty" name:"SucFaceRects"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateFaceResponse ¶
func NewCreateFaceResponse() (response *CreateFaceResponse)
func (*CreateFaceResponse) FromJsonString ¶
func (r *CreateFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateFaceResponse) ToJsonString ¶
func (r *CreateFaceResponse) ToJsonString() string
type CreateGroupRequest ¶
type CreateGroupRequest struct { *tchttp.BaseRequest // Group name, which is modifiable, must be unique, and can contain 1 to 60 characters. GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group. // Up to 5 ones can be created. // Each custom description field can contain 1 to 30 characters. // The custom description field must be unique in the group. // Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"], // then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number". // You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number. GroupExDescriptions []*string `json:"GroupExDescriptions,omitempty" name:"GroupExDescriptions"` // Group remarks, which can contain 0 to 40 characters. Tag *string `json:"Tag,omitempty" name:"Tag"` // Algorithm model version used by the Face Recognition service. Valid values: 2.0, 3.0. // This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API previously, `2.0` will be used by default. // Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is thus recommended. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` }
func NewCreateGroupRequest ¶
func NewCreateGroupRequest() (request *CreateGroupRequest)
func (*CreateGroupRequest) FromJsonString ¶
func (r *CreateGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateGroupRequest) ToJsonString ¶
func (r *CreateGroupRequest) ToJsonString() string
type CreateGroupResponse ¶
type CreateGroupResponse struct { *tchttp.BaseResponse Response *struct { // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateGroupResponse ¶
func NewCreateGroupResponse() (response *CreateGroupResponse)
func (*CreateGroupResponse) FromJsonString ¶
func (r *CreateGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateGroupResponse) ToJsonString ¶
func (r *CreateGroupResponse) ToJsonString() string
type CreatePersonRequest ¶
type CreatePersonRequest struct { *tchttp.BaseRequest // ID of the group to join, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Person name, which can contain 1 to 60 characters and is modifiable and repeatable. PersonName *string `json:"PersonName,omitempty" name:"PersonName"` // Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // 0: empty; 1: male; 2: female. Gender *int64 `json:"Gender,omitempty" name:"Gender"` // Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable. PersonExDescriptionInfos []*PersonExDescriptionInfo `json:"PersonExDescriptionInfos,omitempty" name:"PersonExDescriptionInfos"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group. // If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned. // Otherwise, the new person will be created. // 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group. // 1: low duplicate person judgment requirement (1% FAR); // 2: average duplicate person judgment requirement (0.1% FAR); // 3: high duplicate person judgment requirement (0.01% FAR); // 4: very high duplicate person judgment requirement (0.001% FAR). // Default value: 0. // Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed. UniquePersonControl *uint64 `json:"UniquePersonControl,omitempty" name:"UniquePersonControl"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewCreatePersonRequest ¶
func NewCreatePersonRequest() (request *CreatePersonRequest)
func (*CreatePersonRequest) FromJsonString ¶
func (r *CreatePersonRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreatePersonRequest) ToJsonString ¶
func (r *CreatePersonRequest) ToJsonString() string
type CreatePersonResponse ¶
type CreatePersonResponse struct { *tchttp.BaseResponse Response *struct { // Unique ID of face image. FaceId *string `json:"FaceId,omitempty" name:"FaceId"` // Position of detected face frame. // Note: this field may return null, indicating that no valid values can be obtained. FaceRect *FaceRect `json:"FaceRect,omitempty" name:"FaceRect"` // `PersonId` of suspected duplicate person. // This parameter is meaningful only if the `UniquePersonControl` parameter is not 0 and there is a suspected duplicate person in the group. SimilarPersonId *string `json:"SimilarPersonId,omitempty" name:"SimilarPersonId"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreatePersonResponse ¶
func NewCreatePersonResponse() (response *CreatePersonResponse)
func (*CreatePersonResponse) FromJsonString ¶
func (r *CreatePersonResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreatePersonResponse) ToJsonString ¶
func (r *CreatePersonResponse) ToJsonString() string
type DeleteFaceRequest ¶
type DeleteFaceRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // List of IDs of the faces to be deleted. The array element value is the `FaceId` returned by the `CreateFace` API. FaceIds []*string `json:"FaceIds,omitempty" name:"FaceIds"` }
func NewDeleteFaceRequest ¶
func NewDeleteFaceRequest() (request *DeleteFaceRequest)
func (*DeleteFaceRequest) FromJsonString ¶
func (r *DeleteFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteFaceRequest) ToJsonString ¶
func (r *DeleteFaceRequest) ToJsonString() string
type DeleteFaceResponse ¶
type DeleteFaceResponse struct { *tchttp.BaseResponse Response *struct { // Number of successfully deleted faces SucDeletedNum *uint64 `json:"SucDeletedNum,omitempty" name:"SucDeletedNum"` // List of IDs of successfully deleted faces SucFaceIds []*string `json:"SucFaceIds,omitempty" name:"SucFaceIds"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteFaceResponse ¶
func NewDeleteFaceResponse() (response *DeleteFaceResponse)
func (*DeleteFaceResponse) FromJsonString ¶
func (r *DeleteFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteFaceResponse) ToJsonString ¶
func (r *DeleteFaceResponse) ToJsonString() string
type DeleteGroupRequest ¶
type DeleteGroupRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewDeleteGroupRequest ¶
func NewDeleteGroupRequest() (request *DeleteGroupRequest)
func (*DeleteGroupRequest) FromJsonString ¶
func (r *DeleteGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteGroupRequest) ToJsonString ¶
func (r *DeleteGroupRequest) ToJsonString() string
type DeleteGroupResponse ¶
type DeleteGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteGroupResponse ¶
func NewDeleteGroupResponse() (response *DeleteGroupResponse)
func (*DeleteGroupResponse) FromJsonString ¶
func (r *DeleteGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteGroupResponse) ToJsonString ¶
func (r *DeleteGroupResponse) ToJsonString() string
type DeletePersonFromGroupRequest ¶
type DeletePersonFromGroupRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewDeletePersonFromGroupRequest ¶
func NewDeletePersonFromGroupRequest() (request *DeletePersonFromGroupRequest)
func (*DeletePersonFromGroupRequest) FromJsonString ¶
func (r *DeletePersonFromGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePersonFromGroupRequest) ToJsonString ¶
func (r *DeletePersonFromGroupRequest) ToJsonString() string
type DeletePersonFromGroupResponse ¶
type DeletePersonFromGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeletePersonFromGroupResponse ¶
func NewDeletePersonFromGroupResponse() (response *DeletePersonFromGroupResponse)
func (*DeletePersonFromGroupResponse) FromJsonString ¶
func (r *DeletePersonFromGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePersonFromGroupResponse) ToJsonString ¶
func (r *DeletePersonFromGroupResponse) ToJsonString() string
type DeletePersonRequest ¶
type DeletePersonRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` }
func NewDeletePersonRequest ¶
func NewDeletePersonRequest() (request *DeletePersonRequest)
func (*DeletePersonRequest) FromJsonString ¶
func (r *DeletePersonRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePersonRequest) ToJsonString ¶
func (r *DeletePersonRequest) ToJsonString() string
type DeletePersonResponse ¶
type DeletePersonResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeletePersonResponse ¶
func NewDeletePersonResponse() (response *DeletePersonResponse)
func (*DeletePersonResponse) FromJsonString ¶
func (r *DeletePersonResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePersonResponse) ToJsonString ¶
func (r *DeletePersonResponse) ToJsonString() string
type DetectFaceRequest ¶
type DetectFaceRequest struct { *tchttp.BaseRequest // Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120. // This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing. MaxFaceNum *uint64 `json:"MaxFaceNum,omitempty" name:"MaxFaceNum"` // Minimum height and width of face in px. // Default value: 34. We recommend keeping it at or above 34. // Faces below the `MinFaceSize` value will not be detected. MinFaceSize *uint64 `json:"MinFaceSize,omitempty" name:"MinFaceSize"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0. // If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case. // The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless. // Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection. NeedFaceAttributes *uint64 `json:"NeedFaceAttributes,omitempty" name:"NeedFaceAttributes"` // Whether to enable quality detection. 0: no; 1: yes. Default value: 0. // If the value is not 1, it will be deemed not to perform quality detection. // The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless. // We recommend enabling this feature for the face adding operation. NeedQualityDetection *uint64 `json:"NeedQualityDetection,omitempty" name:"NeedQualityDetection"` // Algorithm model version used by the Face Recognition service. Valid values: 2.0, 3.0. // This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API previously, `2.0` will be used by default. // Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is thus recommended. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewDetectFaceRequest ¶
func NewDetectFaceRequest() (request *DetectFaceRequest)
func (*DetectFaceRequest) FromJsonString ¶
func (r *DetectFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetectFaceRequest) ToJsonString ¶
func (r *DetectFaceRequest) ToJsonString() string
type DetectFaceResponse ¶
type DetectFaceResponse struct { *tchttp.BaseResponse Response *struct { // Width of requested image. ImageWidth *int64 `json:"ImageWidth,omitempty" name:"ImageWidth"` // Height of requested image. ImageHeight *int64 `json:"ImageHeight,omitempty" name:"ImageHeight"` // Face information list, including face coordinate information, attribute information (if needed), and quality score information (if needed). FaceInfos []*FaceInfo `json:"FaceInfos,omitempty" name:"FaceInfos"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDetectFaceResponse ¶
func NewDetectFaceResponse() (response *DetectFaceResponse)
func (*DetectFaceResponse) FromJsonString ¶
func (r *DetectFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetectFaceResponse) ToJsonString ¶
func (r *DetectFaceResponse) ToJsonString() string
type DetectLiveFaceRequest ¶
type DetectLiveFaceRequest struct { *tchttp.BaseRequest // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats (the aspect ratio of the image should be close to 3:4 (width:height); otherwise, the score returned for the image will be meaningless). // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // (The aspect ratio of the image should be close to 3:4 (width:height); otherwise, the score returned for the image will be meaningless.) // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Algorithm model version used by the Face Recognition service. Valid values: 2.0, 3.0. // This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API previously, `2.0` will be used by default. // Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is thus recommended. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` }
func NewDetectLiveFaceRequest ¶
func NewDetectLiveFaceRequest() (request *DetectLiveFaceRequest)
func (*DetectLiveFaceRequest) FromJsonString ¶
func (r *DetectLiveFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetectLiveFaceRequest) ToJsonString ¶
func (r *DetectLiveFaceRequest) ToJsonString() string
type DetectLiveFaceResponse ¶
type DetectLiveFaceResponse struct { *tchttp.BaseResponse Response *struct { // Liveness score. Value range: [0,100]. The score is generally between 80 and 100, but 0 is also a common value. As a recommendation, when the score is greater than 87, it can be judged that the person in the image is alive. You can adjust the threshold according to your specific scenario. // This field is meaningful only if `FaceModelVersion` is 2.0. Score *float64 `json:"Score,omitempty" name:"Score"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Whether liveness detection is passed. // This field is meaningful only if `FaceModelVersion` is 3.0. IsLiveness *bool `json:"IsLiveness,omitempty" name:"IsLiveness"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDetectLiveFaceResponse ¶
func NewDetectLiveFaceResponse() (response *DetectLiveFaceResponse)
func (*DetectLiveFaceResponse) FromJsonString ¶
func (r *DetectLiveFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetectLiveFaceResponse) ToJsonString ¶
func (r *DetectLiveFaceResponse) ToJsonString() string
type FaceAttributesInfo ¶
type FaceAttributesInfo struct { // Gender. The gender is female for the value range [0,49] and male for the value range [50,100]. The closer the value to 0 or 100, the higher the confidence. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. Gender *int64 `json:"Gender,omitempty" name:"Gender"` // Age. Value range: [0,100]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. Age *int64 `json:"Age,omitempty" name:"Age"` // Expression. Value range: [0 (normal)–50 (smile)–100 (laugh)]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. Expression *int64 `json:"Expression,omitempty" name:"Expression"` // Whether glasses are present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. Glass *bool `json:"Glass,omitempty" name:"Glass"` // Vertical offset in degrees. Value range: [-30,30]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // We recommend selecting images in the [-10,10] range for adding faces. Pitch *int64 `json:"Pitch,omitempty" name:"Pitch"` // Horizontal offset in degrees. Value range: [-30,30]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // We recommend selecting images in the [-10,10] range for adding faces. Yaw *int64 `json:"Yaw,omitempty" name:"Yaw"` // Horizontal rotation in degrees. Value range: [-180,180]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // We recommend selecting images in the [-20,20] range for adding faces. Roll *int64 `json:"Roll,omitempty" name:"Roll"` // Beauty. Value range: [0,100]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. Beauty *int64 `json:"Beauty,omitempty" name:"Beauty"` // Whether hat is present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // Note: this field may return null, indicating that no valid values can be obtained. Hat *bool `json:"Hat,omitempty" name:"Hat"` // Whether mask is present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // Note: this field may return null, indicating that no valid values can be obtained. Mask *bool `json:"Mask,omitempty" name:"Mask"` // Hair information, including length, bang, and color. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // Note: this field may return null, indicating that no valid values can be obtained. Hair *FaceHairAttributesInfo `json:"Hair,omitempty" name:"Hair"` // Whether the eyes are open. Valid values: true, false. As long as there is more than one eye closed, `false` will be returned. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless. // Note: this field may return null, indicating that no valid values can be obtained. EyeOpen *bool `json:"EyeOpen,omitempty" name:"EyeOpen"` }
type FaceHairAttributesInfo ¶
type FaceHairAttributesInfo struct { // 0: shaved head, 1: short hair, 2: medium hair, 3: long hair, 4: braid // Note: this field may return null, indicating that no valid values can be obtained. Length *int64 `json:"Length,omitempty" name:"Length"` // 0: with bangs, 1: no bangs // Note: this field may return null, indicating that no valid values can be obtained. Bang *int64 `json:"Bang,omitempty" name:"Bang"` // 0: black, 1: golden, 2: brown, 3: gray // Note: this field may return null, indicating that no valid values can be obtained. Color *int64 `json:"Color,omitempty" name:"Color"` }
type FaceInfo ¶
type FaceInfo struct { // Horizontal coordinate of the top-left vertex of the face frame. // The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative. // If you want to capture a complete face, you can set the negative coordinates to 0 if the `completeness` score meets the requirement. X *int64 `json:"X,omitempty" name:"X"` // Vertical coordinate of the top-left vertex of the face frame. // The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative. // If you want to capture a complete face, you can set the negative coordinates to 0 if the `completeness` score meets the requirement. Y *int64 `json:"Y,omitempty" name:"Y"` // Face frame width. Width *int64 `json:"Width,omitempty" name:"Width"` // Face frame height. Height *int64 `json:"Height,omitempty" name:"Height"` // Face attributes, including gender, age, expression, // beauty, glass, mask, hair, and pose (pitch, roll, yaw). Valid information will be returned only if `NeedFaceAttributes` is set to 1. FaceAttributesInfo *FaceAttributesInfo `json:"FaceAttributesInfo,omitempty" name:"FaceAttributesInfo"` // Face quality information, including score, sharpness, brightness, and completeness. Valid information will be returned only if `NeedFaceDetection` is set to 1. // Note: this field may return null, indicating that no valid values can be obtained. FaceQualityInfo *FaceQualityInfo `json:"FaceQualityInfo,omitempty" name:"FaceQualityInfo"` }
type FaceQualityCompleteness ¶
type FaceQualityCompleteness struct { // Eyebrow completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,80], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Eyebrow *int64 `json:"Eyebrow,omitempty" name:"Eyebrow"` // Eye completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,80], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Eye *int64 `json:"Eye,omitempty" name:"Eye"` // Nose completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,60], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Nose *int64 `json:"Nose,omitempty" name:"Nose"` // Cheek completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,70], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Cheek *int64 `json:"Cheek,omitempty" name:"Cheek"` // Mouth completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,50], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Mouth *int64 `json:"Mouth,omitempty" name:"Mouth"` // Chin completeness. Value range: [0,100]. The higher the score, the higher the completeness. // Reference range: [0,70], which means incomplete. // Note: this field may return null, indicating that no valid values can be obtained. Chin *int64 `json:"Chin,omitempty" name:"Chin"` }
type FaceQualityInfo ¶
type FaceQualityInfo struct { // Quality score. Value range: [0,100]. It comprehensively evaluates whether the image quality is suitable for face recognition; the higher the score, the higher the quality. // In normal cases, you only need to use `Score` as the overall quality standard score. Specific item scores such as `Sharpness`, `Brightness`, `Completeness` are for reference only. // Reference range: [0,40]: poor; [40,60]: fine; [60,80]: good; [80,100]: excellent. // We recommend selecting images with a score above 70 for adding faces. // Note: this field may return null, indicating that no valid values can be obtained. Score *int64 `json:"Score,omitempty" name:"Score"` // Sharpness. Value range: [0,100]. It evaluates the sharpness of the image. The higher the score, the sharper the image. // Reference range: [0,40]: very blurry; [40,60]: blurry; [60,80]: fine; [80,100]: sharp. // We recommend selecting images with a score above 80 for adding faces. // Note: this field may return null, indicating that no valid values can be obtained. Sharpness *int64 `json:"Sharpness,omitempty" name:"Sharpness"` // Brightness. Value range: [0,100]. The brighter the image, the higher the score. // Reference range: [0,30]: dark; [30,70]: normal; [70,100]: bright. // We recommend selecting images in the [30,70] range for adding faces. // Note: this field may return null, indicating that no valid values can be obtained. Brightness *int64 `json:"Brightness,omitempty" name:"Brightness"` // Completeness of facial features, which assesses the completeness of the eyebrows, eyes, nose, cheeks, mouth, and chin. // Note: this field may return null, indicating that no valid values can be obtained. Completeness *FaceQualityCompleteness `json:"Completeness,omitempty" name:"Completeness"` }
type FaceRect ¶
type FaceRect struct { // Horizontal coordinate of the top-left vertex of face frame. // The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative. // If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement. X *int64 `json:"X,omitempty" name:"X"` // Vertical coordinate of the top-left vertex of face frame. // The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative. // If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement. Y *int64 `json:"Y,omitempty" name:"Y"` // Face width Width *uint64 `json:"Width,omitempty" name:"Width"` // Face height Height *uint64 `json:"Height,omitempty" name:"Height"` }
type FaceShape ¶
type FaceShape struct { // 21 points that describe the face contour. FaceProfile []*Point `json:"FaceProfile,omitempty" name:"FaceProfile"` // 8 points that describe the left eye. LeftEye []*Point `json:"LeftEye,omitempty" name:"LeftEye"` // 8 points that describe the right eye. RightEye []*Point `json:"RightEye,omitempty" name:"RightEye"` // 8 points that describe the left eyebrow. LeftEyeBrow []*Point `json:"LeftEyeBrow,omitempty" name:"LeftEyeBrow"` // 8 points that describe the right eyebrow. RightEyeBrow []*Point `json:"RightEyeBrow,omitempty" name:"RightEyeBrow"` // 22 points that describe the mouth. Mouth []*Point `json:"Mouth,omitempty" name:"Mouth"` // 13 points that describe the nose. Nose []*Point `json:"Nose,omitempty" name:"Nose"` // 1 point that describes the left pupil. LeftPupil []*Point `json:"LeftPupil,omitempty" name:"LeftPupil"` // 1 point that describes the right pupil. RightPupil []*Point `json:"RightPupil,omitempty" name:"RightPupil"` }
type GetGroupInfoRequest ¶
type GetGroupInfoRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewGetGroupInfoRequest ¶
func NewGetGroupInfoRequest() (request *GetGroupInfoRequest)
func (*GetGroupInfoRequest) FromJsonString ¶
func (r *GetGroupInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetGroupInfoRequest) ToJsonString ¶
func (r *GetGroupInfoRequest) ToJsonString() string
type GetGroupInfoResponse ¶
type GetGroupInfoResponse struct { *tchttp.BaseResponse Response *struct { // Group name GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Custom group description field GroupExDescriptions []*string `json:"GroupExDescriptions,omitempty" name:"GroupExDescriptions"` // Group remarks Tag *string `json:"Tag,omitempty" name:"Tag"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time. CreationTimestamp *uint64 `json:"CreationTimestamp,omitempty" name:"CreationTimestamp"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetGroupInfoResponse ¶
func NewGetGroupInfoResponse() (response *GetGroupInfoResponse)
func (*GetGroupInfoResponse) FromJsonString ¶
func (r *GetGroupInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetGroupInfoResponse) ToJsonString ¶
func (r *GetGroupInfoResponse) ToJsonString() string
type GetGroupListRequest ¶
type GetGroupListRequest struct { *tchttp.BaseRequest // Starting number. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results. Default value: 10. Maximum value: 1000. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewGetGroupListRequest ¶
func NewGetGroupListRequest() (request *GetGroupListRequest)
func (*GetGroupListRequest) FromJsonString ¶
func (r *GetGroupListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetGroupListRequest) ToJsonString ¶
func (r *GetGroupListRequest) ToJsonString() string
type GetGroupListResponse ¶
type GetGroupListResponse struct { *tchttp.BaseResponse Response *struct { // Returned group information GroupInfos []*GroupInfo `json:"GroupInfos,omitempty" name:"GroupInfos"` // Total number of groups // Note: this field may return null, indicating that no valid values can be obtained. GroupNum *uint64 `json:"GroupNum,omitempty" name:"GroupNum"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetGroupListResponse ¶
func NewGetGroupListResponse() (response *GetGroupListResponse)
func (*GetGroupListResponse) FromJsonString ¶
func (r *GetGroupListResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetGroupListResponse) ToJsonString ¶
func (r *GetGroupListResponse) ToJsonString() string
type GetPersonBaseInfoRequest ¶
type GetPersonBaseInfoRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` }
func NewGetPersonBaseInfoRequest ¶
func NewGetPersonBaseInfoRequest() (request *GetPersonBaseInfoRequest)
func (*GetPersonBaseInfoRequest) FromJsonString ¶
func (r *GetPersonBaseInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonBaseInfoRequest) ToJsonString ¶
func (r *GetPersonBaseInfoRequest) ToJsonString() string
type GetPersonBaseInfoResponse ¶
type GetPersonBaseInfoResponse struct { *tchttp.BaseResponse Response *struct { // Person name PersonName *string `json:"PersonName,omitempty" name:"PersonName"` // Person gender. 0: empty; 1: male; 2: female. Gender *int64 `json:"Gender,omitempty" name:"Gender"` // List of the IDs of included faces FaceIds []*string `json:"FaceIds,omitempty" name:"FaceIds"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetPersonBaseInfoResponse ¶
func NewGetPersonBaseInfoResponse() (response *GetPersonBaseInfoResponse)
func (*GetPersonBaseInfoResponse) FromJsonString ¶
func (r *GetPersonBaseInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonBaseInfoResponse) ToJsonString ¶
func (r *GetPersonBaseInfoResponse) ToJsonString() string
type GetPersonGroupInfoRequest ¶
type GetPersonGroupInfoRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Starting number. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results. Default value: 10. Maximum value: 100. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewGetPersonGroupInfoRequest ¶
func NewGetPersonGroupInfoRequest() (request *GetPersonGroupInfoRequest)
func (*GetPersonGroupInfoRequest) FromJsonString ¶
func (r *GetPersonGroupInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonGroupInfoRequest) ToJsonString ¶
func (r *GetPersonGroupInfoRequest) ToJsonString() string
type GetPersonGroupInfoResponse ¶
type GetPersonGroupInfoResponse struct { *tchttp.BaseResponse Response *struct { // List of groups containing this person and their description fields PersonGroupInfos []*PersonGroupInfo `json:"PersonGroupInfos,omitempty" name:"PersonGroupInfos"` // Total number of groups // Note: this field may return null, indicating that no valid values can be obtained. GroupNum *uint64 `json:"GroupNum,omitempty" name:"GroupNum"` // Algorithm model version used by the Face Recognition service. // Note: this field may return null, indicating that no valid values can be obtained. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetPersonGroupInfoResponse ¶
func NewGetPersonGroupInfoResponse() (response *GetPersonGroupInfoResponse)
func (*GetPersonGroupInfoResponse) FromJsonString ¶
func (r *GetPersonGroupInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonGroupInfoResponse) ToJsonString ¶
func (r *GetPersonGroupInfoResponse) ToJsonString() string
type GetPersonListNumRequest ¶
type GetPersonListNumRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewGetPersonListNumRequest ¶
func NewGetPersonListNumRequest() (request *GetPersonListNumRequest)
func (*GetPersonListNumRequest) FromJsonString ¶
func (r *GetPersonListNumRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonListNumRequest) ToJsonString ¶
func (r *GetPersonListNumRequest) ToJsonString() string
type GetPersonListNumResponse ¶
type GetPersonListNumResponse struct { *tchttp.BaseResponse Response *struct { // Number of persons PersonNum *uint64 `json:"PersonNum,omitempty" name:"PersonNum"` // Number of faces FaceNum *uint64 `json:"FaceNum,omitempty" name:"FaceNum"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetPersonListNumResponse ¶
func NewGetPersonListNumResponse() (response *GetPersonListNumResponse)
func (*GetPersonListNumResponse) FromJsonString ¶
func (r *GetPersonListNumResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonListNumResponse) ToJsonString ¶
func (r *GetPersonListNumResponse) ToJsonString() string
type GetPersonListRequest ¶
type GetPersonListRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Starting number. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results. Default value: 10. Maximum value: 1000. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewGetPersonListRequest ¶
func NewGetPersonListRequest() (request *GetPersonListRequest)
func (*GetPersonListRequest) FromJsonString ¶
func (r *GetPersonListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonListRequest) ToJsonString ¶
func (r *GetPersonListRequest) ToJsonString() string
type GetPersonListResponse ¶
type GetPersonListResponse struct { *tchttp.BaseResponse Response *struct { // Returned person information PersonInfos []*PersonInfo `json:"PersonInfos,omitempty" name:"PersonInfos"` // Number of persons in the group // Note: this field may return null, indicating that no valid values can be obtained. PersonNum *uint64 `json:"PersonNum,omitempty" name:"PersonNum"` // Number of faces in the group // Note: this field may return null, indicating that no valid values can be obtained. FaceNum *uint64 `json:"FaceNum,omitempty" name:"FaceNum"` // Algorithm model version used for face recognition. // Note: this field may return null, indicating that no valid values can be obtained. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetPersonListResponse ¶
func NewGetPersonListResponse() (response *GetPersonListResponse)
func (*GetPersonListResponse) FromJsonString ¶
func (r *GetPersonListResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPersonListResponse) ToJsonString ¶
func (r *GetPersonListResponse) ToJsonString() string
type GroupCandidate ¶
type GroupExDescriptionInfo ¶
type GroupExDescriptionInfo struct { // Custom group description field index, whose value starts from 0. // Note: this field may return null, indicating that no valid values can be obtained. GroupExDescriptionIndex *uint64 `json:"GroupExDescriptionIndex,omitempty" name:"GroupExDescriptionIndex"` // Content of the custom group description field to be updated GroupExDescription *string `json:"GroupExDescription,omitempty" name:"GroupExDescription"` }
type GroupInfo ¶
type GroupInfo struct { // Group name GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Custom group description field // Note: this field may return null, indicating that no valid values can be obtained. GroupExDescriptions []*string `json:"GroupExDescriptions,omitempty" name:"GroupExDescriptions"` // Group remarks // Note: this field may return null, indicating that no valid values can be obtained. Tag *string `json:"Tag,omitempty" name:"Tag"` // Algorithm model version used for face recognition. // Note: this field may return null, indicating that no valid values can be obtained. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time. // The UNIX epoch time is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Time (UTC). For more information, please see the UNIX time document. // Note: this field may return null, indicating that no valid values can be obtained. CreationTimestamp *uint64 `json:"CreationTimestamp,omitempty" name:"CreationTimestamp"` }
type ModifyGroupRequest ¶
type ModifyGroupRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Group name GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Custom description field of the group to be modified, which is a `key-value` pair. GroupExDescriptionInfos []*GroupExDescriptionInfo `json:"GroupExDescriptionInfos,omitempty" name:"GroupExDescriptionInfos"` // Group remarks Tag *string `json:"Tag,omitempty" name:"Tag"` }
func NewModifyGroupRequest ¶
func NewModifyGroupRequest() (request *ModifyGroupRequest)
func (*ModifyGroupRequest) FromJsonString ¶
func (r *ModifyGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyGroupRequest) ToJsonString ¶
func (r *ModifyGroupRequest) ToJsonString() string
type ModifyGroupResponse ¶
type ModifyGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyGroupResponse ¶
func NewModifyGroupResponse() (response *ModifyGroupResponse)
func (*ModifyGroupResponse) FromJsonString ¶
func (r *ModifyGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyGroupResponse) ToJsonString ¶
func (r *ModifyGroupResponse) ToJsonString() string
type ModifyPersonBaseInfoRequest ¶
type ModifyPersonBaseInfoRequest struct { *tchttp.BaseRequest // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Name of the person to be modified PersonName *string `json:"PersonName,omitempty" name:"PersonName"` // Gender of the person to be modified. 1: male; 2: female. Gender *int64 `json:"Gender,omitempty" name:"Gender"` }
func NewModifyPersonBaseInfoRequest ¶
func NewModifyPersonBaseInfoRequest() (request *ModifyPersonBaseInfoRequest)
func (*ModifyPersonBaseInfoRequest) FromJsonString ¶
func (r *ModifyPersonBaseInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPersonBaseInfoRequest) ToJsonString ¶
func (r *ModifyPersonBaseInfoRequest) ToJsonString() string
type ModifyPersonBaseInfoResponse ¶
type ModifyPersonBaseInfoResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyPersonBaseInfoResponse ¶
func NewModifyPersonBaseInfoResponse() (response *ModifyPersonBaseInfoResponse)
func (*ModifyPersonBaseInfoResponse) FromJsonString ¶
func (r *ModifyPersonBaseInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPersonBaseInfoResponse) ToJsonString ¶
func (r *ModifyPersonBaseInfoResponse) ToJsonString() string
type ModifyPersonGroupInfoRequest ¶
type ModifyPersonGroupInfoRequest struct { *tchttp.BaseRequest // Group ID, which is the `GroupId` in the `CreateGroup` API. GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Person ID, which is the `PersonId` in the `CreatePerson` API. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Custom description field of the person to be modified, which is a `key-value` pair. PersonExDescriptionInfos []*PersonExDescriptionInfo `json:"PersonExDescriptionInfos,omitempty" name:"PersonExDescriptionInfos"` }
func NewModifyPersonGroupInfoRequest ¶
func NewModifyPersonGroupInfoRequest() (request *ModifyPersonGroupInfoRequest)
func (*ModifyPersonGroupInfoRequest) FromJsonString ¶
func (r *ModifyPersonGroupInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPersonGroupInfoRequest) ToJsonString ¶
func (r *ModifyPersonGroupInfoRequest) ToJsonString() string
type ModifyPersonGroupInfoResponse ¶
type ModifyPersonGroupInfoResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyPersonGroupInfoResponse ¶
func NewModifyPersonGroupInfoResponse() (response *ModifyPersonGroupInfoResponse)
func (*ModifyPersonGroupInfoResponse) FromJsonString ¶
func (r *ModifyPersonGroupInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPersonGroupInfoResponse) ToJsonString ¶
func (r *ModifyPersonGroupInfoResponse) ToJsonString() string
type PersonExDescriptionInfo ¶
type PersonExDescriptionInfo struct { // Person description field index, whose value starts from 0. // Note: this field may return null, indicating that no valid values can be obtained. PersonExDescriptionIndex *uint64 `json:"PersonExDescriptionIndex,omitempty" name:"PersonExDescriptionIndex"` // Content of the person description field to be updated PersonExDescription *string `json:"PersonExDescription,omitempty" name:"PersonExDescription"` }
type PersonGroupInfo ¶
type PersonInfo ¶
type PersonInfo struct { // Person name PersonName *string `json:"PersonName,omitempty" name:"PersonName"` // Person ID PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Person gender Gender *int64 `json:"Gender,omitempty" name:"Gender"` // Content of person description field PersonExDescriptions []*string `json:"PersonExDescriptions,omitempty" name:"PersonExDescriptions"` // List of contained face images FaceIds []*string `json:"FaceIds,omitempty" name:"FaceIds"` // Person creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time. // The UNIX epoch time is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Time (UTC). For more information, please see the UNIX time document. CreationTimestamp *uint64 `json:"CreationTimestamp,omitempty" name:"CreationTimestamp"` }
type Result ¶
type Result struct { // Most matching candidate recognized Candidates []*Candidate `json:"Candidates,omitempty" name:"Candidates"` // Position of detected face frame FaceRect *FaceRect `json:"FaceRect,omitempty" name:"FaceRect"` // Status return code of detected face image. 0: normal. // -1601: the image quality control requirement is not met; in this case, `Candidate` is empty. RetCode *int64 `json:"RetCode,omitempty" name:"RetCode"` }
type ResultsReturnsByGroup ¶
type ResultsReturnsByGroup struct { // Position of detected face frame FaceRect *FaceRect `json:"FaceRect,omitempty" name:"FaceRect"` // Recognition result. GroupCandidates []*GroupCandidate `json:"GroupCandidates,omitempty" name:"GroupCandidates"` // Status return code of detected face image. 0: normal. // -1601: the image quality control requirement is not met; in this case, `Candidate` is empty. RetCode *int64 `json:"RetCode,omitempty" name:"RetCode"` }
type SearchFacesRequest ¶
type SearchFacesRequest struct { *tchttp.BaseRequest // List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API. GroupIds []*string `json:"GroupIds,omitempty" name:"GroupIds"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. // `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. // For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized. MaxFaceNum *uint64 `json:"MaxFaceNum,omitempty" name:"MaxFaceNum"` // Minimum height and width of face in px. Default value: 34. Face images whose value is below 34 cannot be recognized. We recommend setting this parameter to 80. MinFaceSize *uint64 `json:"MinFaceSize,omitempty" name:"MinFaceSize"` // Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100. // For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. // The greater the value, the longer the processing time. We recommend setting a value below 10. MaxPersonNum *uint64 `json:"MaxPersonNum,omitempty" name:"MaxPersonNum"` // Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default. NeedPersonInfo *int64 `json:"NeedPersonInfo,omitempty" name:"NeedPersonInfo"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // In the output parameter `Score`, the result will be returned only if the result value is above the `FaceMatchThreshold` value. Default value: 0. FaceMatchThreshold *float64 `json:"FaceMatchThreshold,omitempty" name:"FaceMatchThreshold"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewSearchFacesRequest ¶
func NewSearchFacesRequest() (request *SearchFacesRequest)
func (*SearchFacesRequest) FromJsonString ¶
func (r *SearchFacesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchFacesRequest) ToJsonString ¶
func (r *SearchFacesRequest) ToJsonString() string
type SearchFacesResponse ¶
type SearchFacesResponse struct { *tchttp.BaseResponse Response *struct { // Recognition result. Results []*Result `json:"Results,omitempty" name:"Results"` // Number of faces included in searched groups. FaceNum *uint64 `json:"FaceNum,omitempty" name:"FaceNum"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSearchFacesResponse ¶
func NewSearchFacesResponse() (response *SearchFacesResponse)
func (*SearchFacesResponse) FromJsonString ¶
func (r *SearchFacesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchFacesResponse) ToJsonString ¶
func (r *SearchFacesResponse) ToJsonString() string
type SearchFacesReturnsByGroupRequest ¶
type SearchFacesReturnsByGroupRequest struct { *tchttp.BaseRequest // List of groups to be searched in (up to 60). The array element value is the `GroupId` in the `CreateGroup` API. GroupIds []*string `json:"GroupIds,omitempty" name:"GroupIds"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. // `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. // For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized. MaxFaceNum *uint64 `json:"MaxFaceNum,omitempty" name:"MaxFaceNum"` // Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80. MinFaceSize *uint64 `json:"MinFaceSize,omitempty" name:"MinFaceSize"` // Detected faces, which is corresponding to the maximum number of returned most matching persons. Default value: 5. Maximum value: 10. // For example, if `MaxFaceNum` is 3 and `MaxPersonNum` is 5, up to 15 (3 * 5) persons will be returned. MaxPersonNumPerGroup *uint64 `json:"MaxPersonNumPerGroup,omitempty" name:"MaxPersonNumPerGroup"` // Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default. NeedPersonInfo *int64 `json:"NeedPersonInfo,omitempty" name:"NeedPersonInfo"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. // Default value: 0. // Value range: [0.0,100.0). FaceMatchThreshold *float64 `json:"FaceMatchThreshold,omitempty" name:"FaceMatchThreshold"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewSearchFacesReturnsByGroupRequest ¶
func NewSearchFacesReturnsByGroupRequest() (request *SearchFacesReturnsByGroupRequest)
func (*SearchFacesReturnsByGroupRequest) FromJsonString ¶
func (r *SearchFacesReturnsByGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchFacesReturnsByGroupRequest) ToJsonString ¶
func (r *SearchFacesReturnsByGroupRequest) ToJsonString() string
type SearchFacesReturnsByGroupResponse ¶
type SearchFacesReturnsByGroupResponse struct { *tchttp.BaseResponse Response *struct { // Number of faces included in searched groups. FaceNum *uint64 `json:"FaceNum,omitempty" name:"FaceNum"` // Recognition result. ResultsReturnsByGroup []*ResultsReturnsByGroup `json:"ResultsReturnsByGroup,omitempty" name:"ResultsReturnsByGroup"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSearchFacesReturnsByGroupResponse ¶
func NewSearchFacesReturnsByGroupResponse() (response *SearchFacesReturnsByGroupResponse)
func (*SearchFacesReturnsByGroupResponse) FromJsonString ¶
func (r *SearchFacesReturnsByGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchFacesReturnsByGroupResponse) ToJsonString ¶
func (r *SearchFacesReturnsByGroupResponse) ToJsonString() string
type SearchPersonsRequest ¶
type SearchPersonsRequest struct { *tchttp.BaseRequest // List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API. GroupIds []*string `json:"GroupIds,omitempty" name:"GroupIds"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. // `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. // For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized. MaxFaceNum *uint64 `json:"MaxFaceNum,omitempty" name:"MaxFaceNum"` // Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80. MinFaceSize *uint64 `json:"MinFaceSize,omitempty" name:"MinFaceSize"` // Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100. // For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. // The greater the value, the longer the processing time. We recommend setting a value below 10. MaxPersonNum *uint64 `json:"MaxPersonNum,omitempty" name:"MaxPersonNum"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0). FaceMatchThreshold *float64 `json:"FaceMatchThreshold,omitempty" name:"FaceMatchThreshold"` // Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default. NeedPersonInfo *int64 `json:"NeedPersonInfo,omitempty" name:"NeedPersonInfo"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewSearchPersonsRequest ¶
func NewSearchPersonsRequest() (request *SearchPersonsRequest)
func (*SearchPersonsRequest) FromJsonString ¶
func (r *SearchPersonsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchPersonsRequest) ToJsonString ¶
func (r *SearchPersonsRequest) ToJsonString() string
type SearchPersonsResponse ¶
type SearchPersonsResponse struct { *tchttp.BaseResponse Response *struct { // Recognition result. Results []*Result `json:"Results,omitempty" name:"Results"` // Number of the persons included in searched groups. If the quality of all faces in the input image does not meet the requirement, 0 will be returned. PersonNum *uint64 `json:"PersonNum,omitempty" name:"PersonNum"` // Algorithm model version used for face recognition. // Note: this field may return null, indicating that no valid values can be obtained. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSearchPersonsResponse ¶
func NewSearchPersonsResponse() (response *SearchPersonsResponse)
func (*SearchPersonsResponse) FromJsonString ¶
func (r *SearchPersonsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchPersonsResponse) ToJsonString ¶
func (r *SearchPersonsResponse) ToJsonString() string
type SearchPersonsReturnsByGroupRequest ¶
type SearchPersonsReturnsByGroupRequest struct { *tchttp.BaseRequest // List of groups to be searched in (up to 60). The array element value is the `GroupId` in the `CreateGroup` API. GroupIds []*string `json:"GroupIds,omitempty" name:"GroupIds"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. // `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. // For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized. MaxFaceNum *uint64 `json:"MaxFaceNum,omitempty" name:"MaxFaceNum"` // Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80. MinFaceSize *uint64 `json:"MinFaceSize,omitempty" name:"MinFaceSize"` // Detected faces, which is corresponding to the maximum number of returned most matching persons. Default value: 5. Maximum value: 10. // For example, if `MaxFaceNum` is 3, `MaxPersonNumPerGroup` is 5, and the `GroupIds` length is 3, up to 45 (3 * 5 * 3) persons will be returned. MaxPersonNumPerGroup *uint64 `json:"MaxPersonNumPerGroup,omitempty" name:"MaxPersonNumPerGroup"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // In the output parameter `Score`, the result will be returned only if the result value is above the `FaceMatchThreshold` value. Default value: 0. FaceMatchThreshold *float64 `json:"FaceMatchThreshold,omitempty" name:"FaceMatchThreshold"` // Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default. NeedPersonInfo *int64 `json:"NeedPersonInfo,omitempty" name:"NeedPersonInfo"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewSearchPersonsReturnsByGroupRequest ¶
func NewSearchPersonsReturnsByGroupRequest() (request *SearchPersonsReturnsByGroupRequest)
func (*SearchPersonsReturnsByGroupRequest) FromJsonString ¶
func (r *SearchPersonsReturnsByGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchPersonsReturnsByGroupRequest) ToJsonString ¶
func (r *SearchPersonsReturnsByGroupRequest) ToJsonString() string
type SearchPersonsReturnsByGroupResponse ¶
type SearchPersonsReturnsByGroupResponse struct { *tchttp.BaseResponse Response *struct { // Number of the persons included in searched groups. If the quality of all faces in the input image does not meet the requirement, 0 will be returned. PersonNum *uint64 `json:"PersonNum,omitempty" name:"PersonNum"` // Recognition result. ResultsReturnsByGroup []*ResultsReturnsByGroup `json:"ResultsReturnsByGroup,omitempty" name:"ResultsReturnsByGroup"` // Algorithm model version used for face recognition. FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSearchPersonsReturnsByGroupResponse ¶
func NewSearchPersonsReturnsByGroupResponse() (response *SearchPersonsReturnsByGroupResponse)
func (*SearchPersonsReturnsByGroupResponse) FromJsonString ¶
func (r *SearchPersonsReturnsByGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SearchPersonsReturnsByGroupResponse) ToJsonString ¶
func (r *SearchPersonsReturnsByGroupResponse) ToJsonString() string
type VerifyFaceRequest ¶
type VerifyFaceRequest struct { *tchttp.BaseRequest // ID of the person to be verified. For more information on `PersonId`, please see the group management APIs. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Base64-encoded image data, which cannot exceed 5 MB. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewVerifyFaceRequest ¶
func NewVerifyFaceRequest() (request *VerifyFaceRequest)
func (*VerifyFaceRequest) FromJsonString ¶
func (r *VerifyFaceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyFaceRequest) ToJsonString ¶
func (r *VerifyFaceRequest) ToJsonString() string
type VerifyFaceResponse ¶
type VerifyFaceResponse struct { *tchttp.BaseResponse Response *struct { // Similarity between given face image and `PersonId`. If there are multiple faces under the `PersonId`, the score of the highest similarity will be returned. // // The returned similarity score varies by algorithm version. // If you need to verify whether the faces in the two images are the same person, then the 0.1%, 0.01%, and 0.001% FARs on v3.0 correspond to scores of 40, 50, and 60, respectively. Generally, if the score is above 50, it can be judged that they are the same person. // The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90, respectively. Generally, if the score is above 80, it can be judged that they are the same person. Score *float64 `json:"Score,omitempty" name:"Score"` // Whether the person in the image matches the `PersonId`. IsMatch *bool `json:"IsMatch,omitempty" name:"IsMatch"` // Algorithm model version used for face recognition in the group where the `Person` is, which is set when the group is created. For more information, please see [Algorithm Model Version](https://intl.cloud.tencent.com/document/product/867/40042?from_cn_redirect=1) FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewVerifyFaceResponse ¶
func NewVerifyFaceResponse() (response *VerifyFaceResponse)
func (*VerifyFaceResponse) FromJsonString ¶
func (r *VerifyFaceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyFaceResponse) ToJsonString ¶
func (r *VerifyFaceResponse) ToJsonString() string
type VerifyPersonRequest ¶
type VerifyPersonRequest struct { *tchttp.BaseRequest // ID of the person to be verified. For more information on `PersonId`, please see the group management APIs. PersonId *string `json:"PersonId,omitempty" name:"PersonId"` // Base64-encoded data of the image. // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Image *string `json:"Image,omitempty" name:"Image"` // Image URL // The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. // Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. // We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. // The download speed and stability of non-Tencent Cloud URLs may be low. // If there are multiple faces in the image, only the face with the largest size will be selected. // PNG, JPG, JPEG, and BMP images are supported, while GIF images are not. Url *string `json:"Url,omitempty" name:"Url"` // Image quality control. // 0: no control. // 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. // 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. // 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. // 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. // Default value: 0. // If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory. QualityControl *uint64 `json:"QualityControl,omitempty" name:"QualityControl"` // Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled. NeedRotateDetection *uint64 `json:"NeedRotateDetection,omitempty" name:"NeedRotateDetection"` }
func NewVerifyPersonRequest ¶
func NewVerifyPersonRequest() (request *VerifyPersonRequest)
func (*VerifyPersonRequest) FromJsonString ¶
func (r *VerifyPersonRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyPersonRequest) ToJsonString ¶
func (r *VerifyPersonRequest) ToJsonString() string
type VerifyPersonResponse ¶
type VerifyPersonResponse struct { *tchttp.BaseResponse Response *struct { // Similarity between given face image and `PersonId`. If there are multiple faces under the `PersonId`, their information will be fused for verification. Score *float64 `json:"Score,omitempty" name:"Score"` // Whether the person in the image matches the `PersonId`. IsMatch *bool `json:"IsMatch,omitempty" name:"IsMatch"` // Algorithm model version used for face recognition in the group where the `Person` is, which is set when the group is created. For more information, please see [Algorithm Model Version](https://intl.cloud.tencent.com/document/product/867/40042?from_cn_redirect=1) FaceModelVersion *string `json:"FaceModelVersion,omitempty" name:"FaceModelVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewVerifyPersonResponse ¶
func NewVerifyPersonResponse() (response *VerifyPersonResponse)
func (*VerifyPersonResponse) FromJsonString ¶
func (r *VerifyPersonResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyPersonResponse) ToJsonString ¶
func (r *VerifyPersonResponse) ToJsonString() string