SearchMediaByMultimodal-阿里云帮助中心

Operation description

For questions about the Intelligent Media Services intelligent media asset search feature or related issues, search for the DingTalk group (30415005038) and join the Intelligent Media Services multimodal search Customer support DingTalk group to 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:SearchMediaByMultimodal

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The search library.	test-1
MediaType	string	No	The type of the media assets. Valid values: image video (default) Valid values: image : image video : video	video
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 50.	10
Text	string	No	The content that you want to query. You can describe the content in natural language.	Two pandas fighting
Namespace	string	No	Namespace.	name-1
CustomFilters	string	No	Custom filters. A JSON string. Supported backing fields include integer field intField1 and string fields strField1 and strField2. Only one matching condition can be applied per field, and filters across different fields are combined with a logical AND relationship. Exact match example: {"intField1":12,"strField1":"abc"} Multi-value match example: {"intField1":[12,13],"strField1":["abc","cd"]} Range match example: {"intField1":{"gte":12,"lte":13}}	{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}
UtcCreate	string	No	Creation time, in milliseconds UNIX timestamp. gte indicates greater than or equal to, and lte indicates less than or equal to. Range example: {"gte":1761205662998,"lte":1771205662998}	{"gte":1761205662998,"lte":1771205662998}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	**63E8B7C7-4812-46AD-0FA56029AC86**
Success	string	Indicates whether the request was successful. Valid values: true false	true
Code	string	The status code returned.	200
MediaList	array<object>	The media assets that contain the specified content.
	array<object>	The information about the media asset.
MediaId	string	The ID of the media asset.	a18936e0e28771edb59ae6f6f47a****
ClipInfo	array<object>	The information about the clip.
	object
From	number	The start time of the clip.	2
To	number	The end time of the clip.	4
Score	number	The score.	0.99
Total	integer	The total number of data records that meet the specified filter condition.	20

Examples

Success response

JSON format

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Success": "true",
  "Code": "200",
  "MediaList": [
    {
      "MediaId": "a18936e0e28771edb59ae6f6f47a****",
      "ClipInfo": [
        {
          "From": 2,
          "To": 4,
          "Score": 0.99
        }
      ]
    }
  ],
  "Total": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.