All Products
Search
Document Center

Intelligent Media Services:SearchMediaByMultimodal

Last Updated:Dec 16, 2024

Queries media assets by using the large visual model. You can use natural language for the query.

Operation description

If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:SearchMediaByMultimodal
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SearchLibNamestringNo

The search library.

test-1
MediaTypestringNo

The type of the media assets.

Valid values:

  • image
  • video (default)
video
PageNointegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 50.

10
TextstringNo

The content that you want to query. You can describe the content in natural language.

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

****63E8B7C7-4812-46AD-0FA56029AC86****
Successstring

Indicates whether the request was successful. Valid values: true false

true
Codestring

The status code returned.

200
MediaListarray<object>

The media assets that contain the specified content.

MediaListobject

The information about the media asset.

MediaIdstring

The ID of the media asset.

a18936e0e28771edb59ae6f6f47a****
ClipInfoarray<object>

The information about the clip.

ClipInfoobject
Fromdouble

The start time of the clip.

2
Todouble

The end time of the clip.

4
Scoredouble

The score.

1.2
Totallong

The total number of data records that meet the specified filter condition.

20

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.