Call the CompareImageFaces API to compare face similarity in two images - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Operation description

Before you call this operation, familiarize yourself with the billing of Intelligent Media Management (IMM).
For each input image, only the face with the largest bounding box is used for comparison. The detection result is consistent with the response of the DetectImageFaces operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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 authorization chain settings. For more information, see Use authorization chains to access resources of other entities.
Source	object	No	The URLs of the two images for comparison.
URI1	string	No	The OSS URL of the image file. Specify the URL in the `oss://<bucket>/<object>` format. `<bucket>` specifies the name of the OSS bucket that is in the same region as the current project. `<object>` specifies path of the object with the extension included.	oss://test-bucket/test-object1
URI2	string	No	The OSS URL of the image file. Specify the URL in the `oss://<bucket>/<object>` format. `<bucket>` specifies the name of the OSS bucket that is in the same region as the current project, and `<object>` specifies the path of the object with the extension included.	oss://test-bucket/test-object2

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	F73AC982-2B9E-4ECD-AED5-F8331C5******
Similarity	number	The face similarity score. A larger value indicates higher similarity. Valid values: 0 to 1.	0.8848152756690983

Examples

Success response

JSON format

{
  "RequestId": "F73AC982-2B9E-4ECD-AED5-F8331C5******",
  "Similarity": 0.8848152756690983
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.