GetSmartHandleJob-Intelligent Media Services(IMS)-阿里云帮助中心

Retrieves the task result of a smart node. You can obtain the smart node information and execute result based on the node ID. This operation only supports querying editing node data from the past year.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The job ID.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**
Output	string	The task result of the node.	{}
JobResult	object	The task result of the node.
MediaId	string	The media asset ID.	**20b48fb04483915d4f2cd8ac**
AiResult	string	The AI analysis result.	ai result
Usage	string	The token usage. This parameter is returned only for keyword expansion jobs.	{"total_tokens":100}
MediaUrl	string	The URL of the output video for the smart job.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
State	string	The job status. Valid values: Finished : Execution succeeded. Failed : Execution failed. Executing : The job is being executed. Created : The job is submitted successfully.	Finished
UserData	string	The user-defined information.	{"user":"data"}
SmartJobInfo	object	The smart job information.
Title	string	The job title.	Test title
Description	string	The job description.	Test description
UserId	string	The user ID.	1974526429******
InputConfig	object	The input parameters.
InputFile	string	The OSS URL or content library material ID.	oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ****11-DB8D-4A9A-875B-275798****
OutputConfig	object	The output configuration.
Bucket	string	OSS Bucket	test-bucket
Object	string	OSS Object	test-object
CreateTime	string	The creation time. The time is displayed in UTC and follows the ISO 8601 standard.	2020-12-26T04:11:10Z
ModifiedTime	string	The modification time. The time is displayed in UTC and follows the ISO 8601 standard.	2020-12-26T04:11:10Z
JobType	string	The job type.	ASR
ErrorCode	string	The error code returned when the job fails. This parameter is not returned if the job is executed successfully.	SpeechTranslationNoValidVocal
ErrorMessage	string	The error message returned when the job fails. This parameter is not returned if the job is executed successfully.	The speech translation job failed due to lack of valid vocal voice data.

The format of the returned content varies based on the type of the smart job. The following examples show the execution results of various smart jobs.

ASR intelligent subtitling job

{
  "RequestId": "******2D-443C-5043-B0E4-867070******",
  "JobId": "******042d5e4db6866f6289d1******",
  "State": "Finished",
  "SmartJobInfo": {
    "JobType": "ASR",
    "ModifiedTime": "2022-01-21T06:15:08Z",
    "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"
    }
  },
  "JobResult": {
    "AiResult": "[{\"content\":\"Speaking of\",\"from\":0.0,\"to\":0.846},{\"content\":\"they are now extremely popular\",\"from\":0.846,\"to\":3.386},{\"content\":\"often with very high ticket prices\",\"from\":3.386,\"to\":4.402},{\"content\":\"but tickets are snatched up as soon as they go on sale\",\"from\":4.402,\"to\":6.265},{\"content\":\"and they have also participated in various crosstalk variety shows to comment on new performers\",\"from\":6.265,\"to\":10.33}]"
  }
}

Intelligent speech job

{
  "RequestId": "******2D-443C-5043-B0E4-867070******",
  "JobId": "******042d5e4db6866f6289d1******",
  "State": "Finished",
  "SmartJobInfo": {
    "Title": "default_title_2022-01-21T06:15:07Z",
    "JobType": "TextToSpeech",
    "CreateTime": "2022-01-21T06:15:07Z",
    "ModifiedTime": "2022-01-21T06:15:07Z",
    "InputConfig": {
      "InputFile": "Speaking of, they are now extremely popular, often with very high ticket prices, but tickets are snatched up as soon as they go on sale, and they have also participated in various crosstalk variety shows to comment on new performers"
    },
    "EditingConfig": "{\"format\":\"MP3\",\"pitch_rate\":0,\"sample_rate\":16000,\"speech_rate\":0,\"voice\":\"Siqi\",\"volume\":50}",
    "OutputConfig": {
      "Bucket": "your-bucket",
      "Object": "your-audio"
    }
  },
  "JobResult": {
    "MediaId": "******bf47c94e82b3b2014361******",
    "AiResult": "[{\"content\":\"Speaking of\",\"from\":0.0,\"to\":0.846},{\"content\":\"they are now extremely popular\",\"from\":0.846,\"to\":3.386},{\"content\":\"often with very high ticket prices\",\"from\":3.386,\"to\":4.402},{\"content\":\"but tickets are snatched up as soon as they go on sale\",\"from\":4.402,\"to\":6.265},{\"content\":\"and they have also participated in various crosstalk variety shows to comment on new performers\",\"from\":6.265,\"to\":10.33}]"
  }
}

Keyword expansion job

{
	"RequestId":"******AC-5A01-1116-87A4-BF86F2******",
	"UserData":"{\"NotifyAddress\":\"https://****\"}",
	"JobResult":{
		"AiResult":"[\"Newly opened cake shop, using pure animal cream, with a mellow and silky smooth taste, every bite is a sweet surprise, letting your taste buds dance in freshness and purity!\",\"Explore the new world of desserts, our newly opened cake shop selects high-quality animal cream, low sweetness and not greasy, with rich layers, each carrying a unique sweet story of craftsmanship, waiting for you to taste.\",\"Dedicated to you who understand life, newly opened cake shop, strictly selecting animal cream, refusing artificial additives, pure milk fragrance overflowing, light and dense, every bite is a unique tribute to a better life.\"]",
    "Usage": "{\"total_tokens\":200}"
	},
	"State":"Finished",
	"JobId":"******8c784f461db57c99c9d9******",
	"SmartJobInfo":{
		"JobType":"TextGenerate",
		"ModifiedTime":"2024-01-17T08:46:17Z",
		"CreateTime":"2024-01-17T08:46:17Z",
		"Title":"default_title_2024-01-17T08:46:17Z",
		"EditingConfig":"{\"Type\":\"MarketingCopy\",\"GenerateConfig\":\"{\\\"keywords\\\":\\\"newly opened cake shop, animal cream\\\",\\\"textLength\\\":100,\\\"targetCount\\\":3}\"}"
	}
}

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "Output": "{}",
  "JobResult": {
    "MediaId": "****20b48fb04483915d4f2cd8ac****",
    "AiResult": "ai result",
    "Usage": "{\"total_tokens\":100}",
    "MediaUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4"
  },
  "State": "Finished",
  "UserData": "{\"user\":\"data\"}",
  "SmartJobInfo": {
    "Title": "Test title",
    "Description": "Test description",
    "UserId": "1974526429******",
    "InputConfig": {
      "InputFile": "oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ******11-DB8D-4A9A-875B-275798******"
    },
    "OutputConfig": {
      "Bucket": "test-bucket",
      "Object": "test-object"
    },
    "CreateTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "JobType": "ASR"
  },
  "ErrorCode": "SpeechTranslationNoValidVocal",
  "ErrorMessage": "The speech translation job failed due to lack of valid vocal voice data."
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.