Querying Details About a Virtual Avatar Model Training Task
Function
Queries details of a virtual avatar model training task.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
GET /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
job_id |
Yes |
String |
Task ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'. |
|
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
|
X-App-UserId |
No |
String |
Third-party user ID, which does not allow Chinese characters. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Request ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Task ID. |
|
name |
String |
Virtual avatar model name, which is used as its name in the asset library. |
|
state |
String |
Task status. Mapping between these statuses and the statuses displayed on the MetaStudio console:
NOTE:
Tasks in this state need to be handled by the administrator. Users will see the status Algorithm training ongoing.
|
|
asset_id |
String |
Model asset ID. |
|
project_id |
String |
Project ID of a model asset. |
|
cover_download_url |
String |
URL for downloading the virtual avatar model thumbnail. The URL is valid for 24 hours. |
|
last_update_time |
String |
Indicates the last time when a user updates a task (for example, creates or resubmits a task). The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z. |
|
create_time |
String |
Creation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z. |
|
contact |
String |
Mobile number of the creator of the virtual avatar training task. |
|
batch_name |
String |
Batch name of virtual avatar training tasks. |
|
tags |
Array of strings |
Tag of a virtual avatar training task. |
|
model_version |
String |
Virtual avatar model version. The default version is V3.2.
NOTE:
Value range: 0~64 Default value: V3.2 |
|
matting_type |
String |
Matting type. The default value is AI.
Default value: AI |
|
model_resolution |
String |
Virtual avatar model resolution. The default value is 1080P.
Default value: 1080P |
|
app_user_id |
String |
Customized user ID. This parameter is carried if X-App-UserId is set during task creation. |
|
is_flexus |
Boolean |
Whether the image training is of the basic edition |
|
is_live_copy |
Boolean |
Whether it is a task for training a livestream-based avatar. |
|
is_fast_flexus |
Boolean |
Whether it is an ultra-fast Flexus edition. Default value: false |
|
is_only_human_model |
Boolean |
Whether to train the image model but not the voice model. This parameter is valid only for Flexus. The default value is false. Default value: false |
|
optional_training_location |
Array of strings |
Optional training region. |
|
is_background_replacement |
Boolean |
Indicates whether to replace the background for a virtual avatar. If yes, training videos require green-screen shooting. Default value: true |
|
is_ondemand_resource |
Boolean |
Whether the task is on demand. Default value: false |
|
training_video_download_url |
String |
URL for downloading the virtual avatar training video. The URL is valid for 24 hours. |
|
id_card_image1_download_url |
String |
URL for downloading the ID card front-side photo. The URL is valid for 24 hours. |
|
id_card_image2_download_url |
String |
URL for downloading the ID card back-side photo. The URL is valid for 24 hours. |
|
grant_file_download_url |
String |
URL for downloading the authorization letter. The URL is valid for 24 hours. |
|
pre_beauty_image_download_url |
String |
URL for downloading the pre-brightening image. |
|
external_action_json_data_download_url |
String |
URL for downloading the authorization letter. It is valid within 24 hours. |
|
action_video_download_url |
String |
Action video |
|
post_beauty_image_download_url |
String |
URL for downloading the brightened image. |
|
audio_file_download_url |
String |
URL for downloading an audio file. |
|
action_mark_file_download_url |
String |
URL for downloading the action marking file. |
|
action_mark_file_upload_url |
String |
URL for uploading the action marking file. |
|
operation_logs |
Array of OperationLogInfo objects |
Operation logs. |
|
verify_video_matting_info |
Array of VerifyVideoMattingInfo objects |
Non-cropped area when the crop verification video is being generated. |
|
comment_logs |
Array of CommentLogInfo objects |
Comment logs. |
|
samples |
Array of ActionSampleInfo objects |
Action video sample. |
|
is_mask_file_uploaded |
Boolean |
Indicates whether the mask file is uploaded. |
|
mask_file_download_url |
String |
URL for downloading the mask. The URL is valid for 24 hours. |
|
verify_video_download_url |
String |
URL for downloading the video to be reviewed. |
|
markable_video_download_url |
String |
URL for downloading the tagged video. The URL is valid for 24 hours. |
|
markable_action_video_download_url |
String |
URL for downloading the action marking video. It is valid within 24 hours. |
|
traning_video_mark_info |
TrainingVideoMarkInfo object |
Tag information of the virtual avatar training video. |
|
inference_data_process_video_mark_info |
InferenceVideoMarkInfo object |
Information of virtual avatar inference preprocessing video tag. |
|
voice_properties |
VoiceProperties object |
Information of virtual avatar inference preprocessing video tag. |
|
inference_data_process_action_mark_info |
InferenceActionMarkInfo object |
Information of virtual avatar inference preprocessing action tag. |
|
inference_data_process_chat_action_mark_info |
InferenceActionMarkInfo object |
Tag information of inference preprocessing of actions performed by an interactive virtual avatar. |
|
inference_data_process_eye_correction_mark_info |
Information of virtual avatar inference preprocessing video tag. |
|
|
worker_type |
Array of strings |
Compilation task model. |
|
voice_train_job_id |
String |
Voice training task ID. |
|
flexus_retry_count |
Integer |
Number of remaining retraining times of a Flexus task. The value decreases by 1 each time the task is retrained. When the value decreases to 0, the task cannot be retrained. Value range: 0~10 |
|
audio_source_type |
String |
Audio source.
|
|
supported_service |
Array of strings |
Service types supported by the model generated by the task. You can select multiple service types. Flexus virtual avatars support only VIDEO_2D. Default value: [VIDEO_2D,LIVE_2D] |
|
allocated_resource |
TrainingAllocatedResource object |
Resources allocated for avatar training. |
|
train_video_rotation_state |
String |
Status of the training video rotation task.
|
|
action_video_rotation_state |
String |
Status of the training video rotation task.
|
|
sub_training_job_info |
Array of SubTrainingJobInfoDto objects |
Subtask information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
operate_time |
String |
Operation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z. |
|
log_type |
String |
Command output.
|
|
log_description |
String |
Log description. It is used to record the review comments when the manual or automatic review fails. |
|
operate_user |
String |
Operators. Options:
|
|
error_code |
String |
Error code when a request is automatically rejected:
|
|
redo_reasons |
Array of strings |
List of reasons why the task is re-executed by the administrator. |
|
Parameter |
Type |
Description |
|---|---|---|
|
dx |
Integer |
X-axis position of the pixel in the upper left corner of the area. Value range: 0~3840 |
|
dy |
Integer |
Y-axis position of the pixel in the upper left corner of the area. Value range: 0~3840 |
|
width |
Integer |
Area width (pixels). Value range: 1~7680 |
|
height |
Integer |
Area height (pixels). Value range: 1~7680 |
|
method |
String |
Resource operation. Options:
|
|
Parameter |
Type |
Description |
|---|---|---|
|
operate_time |
String |
Operation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z. |
|
comment_type |
String |
|
|
comment_title |
String |
Title. |
|
comment_message |
String |
Message. |
|
attachment_download_url |
Array of strings |
URL for downloading the attachment. |
|
Parameter |
Type |
Description |
|---|---|---|
|
action_name_zh |
String |
Atomic action name in Chinese. |
|
action_name_en |
String |
Atomic action name in English. |
|
action_tag |
String |
Action tag. |
|
catalog |
String |
Action category name. |
|
recommended_value |
Integer |
Recommendation level. Value range: 0~100 |
|
is_selected |
Boolean |
Whether to select this action. Default value: true |
|
sample_download_url |
String |
URL for downloading the atomic action sample file. Valid within 24 hours. |
|
Parameter |
Type |
Description |
|---|---|---|
|
video_start_time |
String |
Start time of the training video. Format: HH:MM:SS.mmm. |
|
video_end_time |
String |
End time of the training video. Format: HH:MM:SS.mmm. |
|
Parameter |
Type |
Description |
|---|---|---|
|
video_start_time |
String |
Start time of the inference preprocessing video. Format: HH:MM:SS.mmm. |
|
video_end_time |
String |
End time of the inference preprocessing video. Format: HH:MM:SS.mmm. |
|
chat_video_start_time |
String |
Start time of the interactive video for inference data preprocessing. Format: HH:MM:SS.mmm. |
|
chat_video_end_time |
String |
End time of the interactive video for inference data preprocessing. Format: HH:MM:SS.mmm. |
|
Parameter |
Type |
Description |
|---|---|---|
|
job_tag |
String |
Task tag, which is a configuration item of the Flexus edition.
|
|
sex |
String |
Voice gender, which is a configuration item of the Flexus edition.
Default value: FEMALE |
|
language |
String |
Training language, which is a configuration item of the Flexus edition. Currently, only Chinese is supported.
|
|
Parameter |
Type |
Description |
|---|---|---|
|
action_info |
Array of ActionMarkItem objects |
Actions. |
|
Parameter |
Type |
Description |
|---|---|---|
|
action_start_time |
String |
Start time of the inference preprocessing video. Format: HH:MM:SS.mmm. |
|
action_end_time |
String |
End time of the inference preprocessing video. Format: HH:MM:SS.mmm. |
|
action_type |
String |
Action type. Options:
Value range: 0~64 |
|
Parameter |
Type |
Description |
|---|---|---|
|
eye_correction_start_time |
String |
Select the start time of inference preprocessing for eye contact correction. Format: HH:MM:SS.mmm. |
|
eye_correction_end_time |
String |
Select the end time of inference preprocessing for eye contact correction. Format: HH:MM:SS.mmm. |
|
Parameter |
Type |
Description |
|---|---|---|
|
resource_id |
String |
Resource ID. |
|
charge_mode |
String |
Resource billing type.
NOTE:
|
|
expire_time |
String |
Resource expiration time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z. |
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Task ID. |
|
sub_job_type |
String |
Subtask type. |
|
heart_beat_id |
String |
Subtask heartbeat ID. |
|
state |
String |
Task status. |
|
create_time |
Long |
Creation time. |
|
last_update_time |
Long |
Last update time. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
https://example.com/rest/v1/***/digital-human-training-manage/user/jobs/efc5300ecdba4ea48d1ff13a9d907bc0
Example Responses
Status code: 200
The information is returned when the request succeeded.
{
"job_id" : "efc5300ecdba4ea48d1ff13a9d907bc0",
"name" : "Test Name",
"state" : "MANUAL_VERIFYING",
"project_id" : "***",
"cover_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?param1=XXX¶m2=YYY",
"create_time" : "2023-12-09T07:31:37Z",
"contact" : "1**********",
"model_version" : "V3",
"matting_type" : "AI",
"model_resolution" : "1080P",
"training_video_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_trainingVideo?param1=XXX¶m2=YYY",
"id_card_image1_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage1?param1=XXX¶m2=YYY",
"id_card_image2_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage2?param1=XXX¶m2=YYY",
"grant_file_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_grantFile?param1=XXX¶m2=YYY",
"operation_logs" : [ {
"operate_time" : "2023-12-09T07:31:37Z",
"log_type" : "USER_CREATE_JOD",
"operate_user" : "USER"
}, {
"operate_time" : "2023-12-09T07:31:43Z",
"log_type" : "SYSTEM_MARKABLE_VIDEO",
"operate_user" : "SYSTEM"
}, {
"operate_time" : "2023-12-09T07:31:43Z",
"log_type" : "USER_VERIFYING_SUBMITTED",
"operate_user" : "USER"
}, {
"operate_time" : "2023-12-09T07:31:43Z",
"log_type" : "SYSTEM_VERIFY_SUCCESS",
"operate_user" : "SYSTEM"
}, {
"operate_time" : "2023-12-09T07:32:45Z",
"log_type" : "SYSTEM_MARKABLE_VIDEO_SUCCESS",
"operate_user" : "SYSTEM"
} ],
"comment_logs" : [ ],
"is_mask_file_uploaded" : false,
"verify_video_download_url" : "null",
"markable_video_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_markableData?param1=XXX¶m2=YYY",
"is_background_replacement" : true
}
Status code: 400
Parameters error, including the error code and its description.
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
Status code: 500
Internal service error.
{
"error_code" : "MSS.00000004",
"error_msg" : "Internal Error"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The information is returned when the request succeeded. |
|
400 |
Parameters error, including the error code and its description. |
|
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot