SearchMediaClipByFace-Intelligent Media Services(IMS)-阿里云帮助中心

Queries media asset clips by face image in exact search mode and returns the clip information of the matched person in the media assets based on rough search results.

Operation description

For usage inquiries or consultations regarding the intelligent media asset search feature of Alibaba Cloud Intelligent Media Services, search for the DingTalk group 30415005038 to join the Intelligent Media Services multimodal search customer support group and contact us.

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

ice:SearchMediaClipByFace

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The name of the search library.	test1
PageNo	integer	No	The current page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 50.	10
EntityId	string	No	The entity ID.	2d3bf1e35a1e42b5ab338d701efa****
FaceSearchToken	string	Yes	The face search token. Keep this value consistent with the FaceSearchToken value in the rough search operation. This parameter is used to determine whether the paginated results are returned under the same search conditions.	zxtest-huangxuan-2023-3-7-V1
MediaId	string	Yes	The media asset ID.	3b187b3620c8490886cfc2a9578c****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	E44FFACD-9E90-555A-A09A-6FD3B7335E39
Success	string	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation fails.	true
Code	string	The return code.	200
MediaClipList	array<object>	The collection of matched media asset clips.
	array<object>
Score	number	The score of the matched clip. The value is a floating-point number in the range of [0, 1].	0.99041677
EntityId	string	The entity ID, which corresponds to the entity ID in the tag analysis result.	1031025****
LabelName	string	The entity name.	ZhangSan
OccurrencesInfos	array<object>	The clustering information of the person clips.
	array<object>
StartTime	number	The start time of the matched clip. The value is a floating-point number in seconds.	61.066353
EndTime	number	The end time of the matched clip. The value is a floating-point number in seconds.	69.06635
TrackData	array<object>	The detailed information of the face in the clip.
	array<object>
Timestamp	number	The timestamp when the face appears in the media asset. The value is a floating-point number in seconds.	62.03302
BoxPosition	object	The coordinate information of the face.
X	integer	The x-axis coordinate of the upper-left vertex. Unit: pixels.	517
Y	integer	The y-axis coordinate of the upper-left vertex. Unit: pixels.	409
W	integer	The width of the bounding box. Unit: pixels.	128
H	integer	The height of the bounding box. Unit: pixels.	168
Expression	string	The facial expression.	peaceful
Category	string	The person type. Valid values: celebrity: Celebrity. sensitive: Sensitive person. politician: Politician. custom: Custom person. unknown: Unknown person.	celebrity
Total	integer	The total number of matched media asset clips.	5

Examples

Success response

JSON format

{
  "RequestId": "E44FFACD-9E90-555A-A09A-6FD3B7335E39",
  "Success": "true",
  "Code": "200",
  "MediaClipList": [
    {
      "Score": 0.99041677,
      "EntityId": "1031025****",
      "LabelName": "ZhangSan",
      "OccurrencesInfos": [
        {
          "StartTime": 61.066353,
          "EndTime": 69.06635,
          "TrackData": [
            {
              "Timestamp": 62.03302,
              "BoxPosition": {
                "X": 517,
                "Y": 409,
                "W": 128,
                "H": 168
              }
            }
          ],
          "Expression": "peaceful"
        }
      ],
      "Category": "celebrity"
    }
  ],
  "Total": 5
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.