Compares the similarity of the largest faces in two images. The largest face refers to the largest face frame in an image after face detection.
Operation description
- Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
- For the input image, only the face with the largest face frame in the image is used for face comparison. The face frame detection result is consistent with the responses of the DetectImageFaces operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| imm:CompareImageFaces | none | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | The name of the project. For more information, see CreateProject . | test-project |
| CredentialConfig | CredentialConfig | No | If you have no special requirements, leave this parameter empty. The configurations of authorization chains. This parameter is optional. For more information, see Use authorization chains to access resources of other entities. | |
| Source | object | No | The URLs of the two images for compression. | |
| URI1 | string | No | The OSS URL of the image file. Specify the URL in the | oss://test-bucket/test-object1 |
| URI2 | string | No | The OSS URL of the image file. Specify the URL in the | oss://test-bucket/test-object2 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "F73AC982-2B9E-4ECD-AED5-F8331C5******",
"Similarity": 0.8848152756690983
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|