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

Searches for media assets by using large models. Users can perform searches by using natural language descriptions.

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:SearchMediaByMultimodal

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The search library.	test-1
MediaType	string	No	The media asset type. Default value: video. Valid values: image: Image. video: Video. Valid values: image : image video : video	video
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
Text	string	No	The search content. It can be a natural language description.	Two pandas are fighting
Namespace	string	No	The namespace.	name-1
CustomFilters	string	No	The custom filters. The value is a JSON string. Supported fields include the integer field intField1 and the string fields strField1 and strField2. You can specify at most one match type for a single field. Filters for different fields are combined by using the AND operator. Examples: Exact match, such as {"intField1":12,"strField1":"abc"}. Multi-value match, such as {"intField1":[12,13],"strField1":["abc","cd"]}. Range match, such as {"intField1":{"gte":12,"lte":13}}.	{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}
UtcCreate	string	No	The creation time. The value is a timestamp in milliseconds. gte specifies greater than or equal to, and lte specifies less than or equal to. Example: Range match, such as {"gte":1761205662998,"lte":1771205662998}.	{"gte":1761205662998,"lte":1771205662998}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	**63E8B7C7-4812-46AD-0FA56029AC86**
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
MediaList	array<object>	The collection of media assets that meet the search criteria.
	array<object>	The details of the media asset.
MediaId	string	The media asset ID.	a18936e0e28771edb59ae6f6f47a****
ClipInfo	array<object>	The clip information.
	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 media assets that meet the search criteria.	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.