All Products
Search
Document Center

Intelligent Media Services:CreateSearchIndex

Last Updated:Dec 16, 2024

Creates a search index in a search library. Each search library can contain multiple indexes.

Operation description

The large visual model feature is still in the public preview phase. You can use this feature for free for 1,000 hours of videos.

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:CreateSearchIndex
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IndexTypestringYes

The category of the index. Valid values:

  • mm: large visual model. You can use this model to describe complex visual features and identify and search for specific actions, movements, and events in videos, such as when athletes score a goal or get injured.
Note This feature is in the public preview phase. You can use this feature for free for 1,000 hours of videos.
  • face: face recognition. You can use the face recognition technology to describe face characteristics and automatically mark or search for faces in videos.
  • aiLabel: smart tagging. The smart tagging category is used to describe content such as subtitles and audio in videos. You can use the speech recognition technology to automatically extract, mark, and search for subtitles and dialog content from videos. This helps you quickly locate the video content that is related to specific topics or keywords.
mm

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

Examples

Sample success responses

JSONformat

{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "Success": "true",
  "Code": "200"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-23The request parameters of the API has changedView Change Details
2023-11-22The request parameters of the API has changed. The response structure of the API has changedView Change Details