SubmitSmarttagJob - - Alibaba Cloud Documentation Center

Submits a Smarttag Job.

Operation description

Prerequisites

Before you submit a Smarttag Job, you must first configure the analysis type in a template.

Limitations

The Smarttag feature is available only in the following Regions: China North 2 (Beijing), China East 2 (Shanghai), and China East 1 (Hangzhou).
The Default Concurrency for the Smarttag Pipeline is 2. To request a higher limit, submit a ticket for evaluation and configuration.
Smarttag Tasks and their results are retained for 180 days and then automatically deleted.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Title	string	No	The video title. Supports Chinese, letters, digits, and hyphens (-). Cannot start with a special character. Max length: 256 bytes.	example-title-****
Content	string	No	A description of the video content. Supports Chinese, letters, digits, and hyphens (-). Cannot start with a special character. Max length: 1 KB.	example content ****
ContentType	string	No	This parameter is deprecated.	application/zip
ContentAddr	string	No	This parameter is deprecated.	http://123.com/testVideo.mp4
Params	string	No	Additional request parameters, as a JSON string. Example: `{"needAsrData":true, "needOcrData":false}`. The following fields are available: (Boolean) Include raw Automatic Speech Recognition (ASR) results in the output. Default: `false`. (Boolean) Include raw Optical Character Recognition (OCR) results in the output. Default: `false`. (Boolean) Include metadata in the output. Default: `false`. A JSON object for configuring the NLP Operator. Skipped if empty. For details, see nlpParams.	{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}
NotifyUrl	string	No	The Callback URL. Only HTTP and HTTPS are supported.	https://example.com/endpoint/aliyun/ai?id=76401125000***
UserData	string	No	Custom user data for MNS Callback. Max length: 1 KB.	{“a”:"test"}
Input	object	No	The input file.
Type	string	No	The media file type. Valid values: `OSS` `Media` `URL`	Media
Media	string	No	If `Type` is `OSS`, provide the OSS URL. Example: `oss://test-bucket/video/202208/test.mp4` If `Type` is `Media`, provide the media ID. Example: `c5c62d8f0361337cab312dce8e77dc6d` If `Type` is `URL`, provide the HTTP URL. Example: `https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4`	c5c62d8f0361337cab312dce8e77dc6d
TemplateId	string	No	The ID of the analysis template. For more information, see Unified Template Configuration.	39f8e0bc005e4f309379701645f4
ScheduleConfig	object	No	The scheduling configuration.
PipelineId	string	No	The Pipeline ID, used to differentiate workflows and associate notifications. If not specified, the Default Pipeline (Concurrency: 2) is used. To increase concurrency, submit a ticket.	acdbfe4323bcfdae
Priority	string	No	The Job priority. This feature is not yet available and is currently ignored.	4
TemplateConfig	string	No	A JSON string of parameters that dynamically override or supplement the Template specified by `TemplateId`. The server merges these runtime parameters with the base template's configuration before execution. Merge Rules: If a field exists in the template, its value is overridden. If a field does not exist in the template, it is added. Supported dynamic fields: `FaceCategoryIds`: A comma-separated list of Face Category IDs (system or custom) for recognition. Note: These parameters only affect the current Task and do not modify the Template.	{"FaceCategoryIds":"custom_face_lib1"}

nlpParams

Feature	Parameter	Type	Required	Description	Example
	nlpParams	object	Yes	Contains all NLP-related parameters. Required if the Template's analysis type includes NLP; otherwise, the task fails.	{"sourceLanguage":"cn"}
Transcription	sourceLanguage	string	Yes	The source language for transcription. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), `fspk` (Chinese-English Mix), `ja` (Japanese). For multi-language audio, set to `multilingual` and use `languageHints`. Supports 16 kHz audio only.	"cn"
	languageHints	list[string]	No	A list of languages for the multilingual model. Helps avoid misidentification. Valid values (multiple): `cn`, `en`, `yue`, `ja`, `ko`, `de`, `fr`, `ru`. Effective only when `sourceLanguage` is `multilingual`.	['cn', 'en', 'yue']
	transcriptionModel	string	No	Specifies the transcription model. Optional: `fun-asr`. Must be used with `sourceLanguage` set to `multilingual`.	fun-asr
	diarizationEnabled	boolean	No	Enable Speaker Diarization. Default: `false`.	true
	speakerCount	integer	No	Configures Speaker Diarization. `0` for an unknown number of speakers, `2` for two speakers. If unset, speakers are not differentiated.	2
Hotword	phraseId	string	No	The hotword vocabulary ID.	ce9c2a34b6d847bf92a77d0a196f***
PPT Extraction & Summarization	pptExtractionEnabled	boolean	No	Enable PPT Extraction and Summarization. If `true`, extracts key frames resembling slides and generates a summary. Default: `false`.	true
Summarization	summarizationEnabled	boolean	No	Enable Summarization. If `true`, can generate a full-text summary and a speaker-based summary.	true
	summarizationTypes	string	No	When Summarization is enabled, specify desired summary types: `Paragraph` (full-text), `Conversational` (speaker), `QuestionsAnswering` (Q&A), and `MindMap` (mind map).	"Paragraph,Conversational,QuestionsAnswering,MindMap"
Translation	translationEnabled	boolean	No	Enable Translation.	true
	targetLanguages	string	No	The target languages for translation. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), `fspk` (Chinese-English Mix).	"en,cn"
Chapter Identification	autoChaptersEnabled	boolean	No	Enable Chapter Identification. Results include chapter titles and summaries.	true
Meeting Assistance	meetingAssistanceEnabled	boolean	No	Enable Meeting Assistance. Results include Classification, Keywords, Key Sentences, and To-do Items.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The Request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The Smarttag Job ID. We recommend saving this ID for subsequent API calls.	**d80e4e4044975745c14b**

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.