Analyze Video Content with SubmitVideoCognitionJob API - IMS - Alibaba Cloud - Intelligent Media Services

Operation description

This is an asynchronous API. After you submit a job, the service returns a job ID and queues it for processing. The final results are delivered via a callback notification. You can also check the job status by calling the QueryIntelligentContentUnderstandingTask operation.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Title	string	No	The title of the video. The title can contain Chinese characters, English letters, digits, and hyphens (-). The title cannot start with a special character and must not exceed 256 bytes in length.	example-title-****
Params	string	No	A JSON string containing additional parameters for operators such as natural language processing, shot detection, custom tagging, and action recognition.	{ "nlpParams": { "sourceLanguage": "cn", "diarizationEnabled": true, "speakerCount": 2, "summarizationEnabled": true, "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap", "translationEnabled": true, "targetLanguages": "en", "autoChaptersEnabled": true, "meetingAssistanceEnabled": true } }
UserData	string	No	The user-defined data. The service returns this data unmodified in the callback notification. This parameter cannot exceed 1,024 bytes.	{"test":1}
Input	object	No	The input media object.
Type	string	No	The type of the input media. Valid values: `OSS` `Media` `URL`	Media
Media	string	No	If `Type` is `OSS`, specify the Object Storage Service (OSS) URL of the media file. Example: `OSS://test-bucket/video/202208/test.mp4` If `Type` is `Media`, specify the media ID. Example: `c5c62d8f0361337cab312dce8e77dc6d` If `Type` is `URL`, specify the HTTP URL of the media file. Example: `https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4`	c5c62d8f03613************c6d
TemplateId	string	No	The ID of the template that specifies the analysis algorithms to use. For more information about managing templates, see Create Custom Template and AI-powered tagging template.	39f8e0bc00***************
TemplateConfig	string	No

nlpParams

Feature	Parameter	Type	Required	Description	Example
	nlpParams	object	Yes	Contains parameters for natural language processing (NLP). This object is required if the template's analysis type includes NLP; otherwise, the job fails.	{"sourceLanguage":"cn"}
Transcription	sourceLanguage	string	Yes	The source language model for transcription. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (mixed Chinese and English).	"cn"
Speaker diarization	diarizationEnabled	boolean	No	Specifies whether to enable speaker diarization. The default value is `false`.	true
	speakerCount	integer	No	The number of speakers for speaker diarization. If you set this to `0`, the service automatically detects the number of speakers. To specify a fixed number of speakers, set the value to that number, for example, `2`.	2
Summarization	summarizationEnabled	boolean	No	Specifies whether to enable summarization. When enabled, the service generates outputs such as a full-text summary and a speaker summary.	true
	summarizationTypes	string	No	Required if `summarizationEnabled` is `true`. Specify one or more of the following summary types: `Paragraph` (full-text summary), `Conversational` (speaker summary), `QuestionsAnswering` (Q&A summary), or `MindMap` (mind map).	"Paragraph,Conversational,QuestionsAnswering,MindMap"
Translation	translationEnabled	boolean	No	Specifies whether to enable translation.	true
	targetLanguages	string	No	The target languages for translation. Required if `translationEnabled` is `true`. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (mixed Chinese and English).	"en,cn"
Chapter detection	autoChaptersEnabled	boolean	No	Specifies whether to enable chapter detection. The results include chapter titles and summaries.	true
Meeting assistance	meetingAssistanceEnabled	boolean	No	Specifies whether to enable meeting assistance. The results include categories, keywords, key sentences, and action items.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
JobId	string	The ID of the job.	**20b48fb04483915d4f2cd8ac**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.