Submit an automatic speech recognition job using SubmitASRJob - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InputFile	string	No	The input file. You can specify an Object Storage Service (OSS) URL or the ID of a media asset in the media asset library.	oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or **20b48fb04483915d4f2cd8ac**
UserData	string	No	The user-defined data in the JSON format. You can specify your business information, such as the business environment and job information.	{ "user": "data", "env": "prod" }
Title	string	No	The job title, which can be up to 128 bytes in length.	Test Title
Description	string	No	The job description, which can up to 128 bytes in length.	Test Description
StartTime	string	No	The start time of the speech to recognize.	00:00:00
Duration	string	No	The speech duration.	00:00:10
EditingConfig	string	No	Audio-to-text recognition configuration: HotwordLibraryIdList: List of hotword library IDs. Currently, only one hotword library ID is supported; support for multiple hotword library IDs simultaneously is planned for the future.	{ "HotwordLibraryIdList": "****2609a14f54a0636b7e16****" }

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**
State	string	The job state. Valid values: Created Executing Finished Failed	Finished

You can use the ASR job JobId to query detailed task execution information through the Get Intelligent Job Result API. The following is a sample return result of the Get Intelligent Job Result API when the task execution Succeeded.

{
  "RequestId": "******2D-443C-5043-B0E4-867070******",
  "JobResult": {
    "AiResult": "[{"content":"Mention","from":0.0,"to":0.846},{"content":"It's extremely popular now","from":0.846,"to":3.386},{"content":"Tickets are often expensive","from":3.386,"to":4.402},{"content":"But it was sold out as soon as it opened","from":4.402,"to":6.265},{"content":"Also participates in various crosstalk variety shows commenting on new performers","from":6.265,"to":10.33}]"
  },
  "State": "Finished",
  "Output": "[{"content":"Mention","from":0.0,"to":0.846},{"content":"It can be said to be extremely popular now","from":0.846,"to":3.386},{"content":"Tickets are often expensive","from":3.386,"to":4.402},{"content":"But it was sold out as soon as it opened","from":4.402,"to":6.265},{"content":"Also participates in various crosstalk variety shows commenting on new performers","from":6.265,"to":10.33}]",
  "JobId": "******042d5e4db6866f6289d1******",
  "SmartJobInfo": {
    "JobType": "ASR",
    "ModifiedTime": "2022-01-21T06:15:08Z",
    "UserId": 1234562230123456,
    "CreateTime": "2022-01-21T06:15:02Z",
    "Title": "default_title_2022-01-21T06:15:02Z",
    "InputConfig": {
      "JobParameters": "{"duration":"00:30:00","start_time":"00:00:00","request_params":"&enable_word_level_result=true"}",
      "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"
    }
  }
}

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.