SearchMediaByHybrid

Updated at:

Performs hybrid search for media assets. Combines intelligent tag text search and large model search capabilities for multi-channel recall, allowing users to search 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:SearchMediaByHybrid

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SearchLibName

string

No

The search library.

test-1

MediaType

string

No

The media asset type.

Valid values:

  • image :

    image

  • video :

    video

video

PageNo

integer

No

The current page number. Default value: 1.

  • image: Images.

  • video: Videos.

1

PageSize

integer

No

The number of entries to return on each page. Default value: 10. Maximum value: 50.

20

Text

string

No

The search content.

Two pandas are fighting

MediaId

string

No

The media asset ID. If specified, detailed hit information of the media asset is returned.

****c469e944b5a856828dc2****

Namespace

string

No

The namespace.

name-1

CustomFilters

string

No

The custom filters. A JSON string. Supports the integer field intField1 and the string fields strField1 and strField2. You can select at most one match type for the same field. Filters for different fields use the AND logical operator.

  • 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. A millisecond timestamp. gte indicates greater than or equal to, and lte indicates less than or equal to.

  • 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.

******3B-0E1A-586A-AC29-742247******

Success

string

Indicates whether the operation is successful. Valid values:

  • true: Successful.

  • false: Failed.

true

Code

string

The return code.

200

MediaList

array<object>

The collection of matched media assets.

array<object>

The collection of matched media assets.

MediaId

string

The media asset ID.

a18936e0e28771edb59ae6f6f47a****

ClipInfo

array<object>

The clip information.

object

The clip information.

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 conditions.

30

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": "true",
  "Code": "200",
  "MediaList": [
    {
      "MediaId": "a18936e0e28771edb59ae6f6f47a****",
      "ClipInfo": [
        {
          "From": 2,
          "To": 4,
          "Score": 0.99
        }
      ]
    }
  ],
  "Total": 30
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.