Help Center/ MetaStudio/ API Reference/ Image Modeling Management/ Querying Details About a Virtual Avatar Model Training Task

Updated on 2024-07-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

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.

URI

GET /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}

**Table 1** Path Parameters
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

**Table 2** Request header 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

**Table 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 4** Response body parameters
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. Options: WAIT_FILE_UPLOAD: To upload files. AUTO_VERIFYING: Auto reviewing. AUTO_VERIFY_FAILED: Auto review failed. MANUAL_VERIFYING: Manually reviewing. MANUAL_VERIFY_FAILED: Manual review failed. MANUAL_VERIFY_SUCCESS: Approved and waiting for resource preprocessing. TRAINING_DATA_PREPROCESSING: Preprocessing training data. TRAINING_DATA_PREPROCESS_FAILED: Training data preprocessing failed. TRAINING_DATA_PREPROCESS_SUCCESS: Training data preprocessed and waiting for resource training. TRAINING: Training. TRAIN_FAILED: Training failed. TRAIN_SUCCESS: Training completed and waiting for resource preprocessing. INFERENCE_DATA_PREPROCESSING: Preprocessing inference data. INFERENCE_DATA_PREPROCESS_FAILED: Inference data preprocessing failed. WAIT_MAIN_FILE_UPLOAD: Waiting for main file upload. JOB_SUCCESS: Training succeeded. WAIT_USER_CONFIRM: Waiting for users to confirm the training result. JOB_REJECT: Training rejected. JOB_PENDING: Training pending. JOB_FINISH: Training finished and cannot be changed.
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	Contact of the virtual avatar training task creator, for example, mobile number or email address.
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 value is V3. V2: V2 model V3: V3 model
matting_type	String	Matting type. The default value is AI. AI: AI matting MANUAL: manual matting
model_resolution	String	Virtual avatar model resolution. The default value is 1080P. 1080P: supports 1080P and 720P video output. 4K: supports 4K, 1080P, and 720P video output.
app_user_id	String	Customized user ID. This parameter is carried if X-App-UserId is set during task creation.
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.
operation_logs	Array of OperationLogInfo objects	Operation logs.
comment_logs	Array of CommentLogInfo objects	Comment logs.
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.
inference_data_process_video_mark_info	InferenceVideoMarkInfo 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_eye_correction_mark_info	InferenceEyeCorrectionMarkInfo object	Information of virtual avatar inference preprocessing video tag.
is_background_replacement	Boolean	Indicates whether to replace the background for a virtual avatar. If yes, training videos require green-screen shooting.
worker_type	Array of strings	Compilation task model.

**Table 5** OperationLogInfo
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 execution result. Options: USER_CREATE_JOD: Virtual avatar customization started. USER_VERIFYING_SUBMITTED: Video submitted for review. SYSTEM_VERIFY_FAILED: Auto review failed. SYSTEM_VERIFY_SUCCESS: Auto review succeeded. ADMIN_VERIFY_SUCCESS: Manually approved. ADMIN_VERIFY_FAILED: Manual review failed. SYSTEM_TRAIN_DATA_PREPROCESSING: Preprocessing training data. SYSTEM_TRAIN_DATA_PREPROCESS_FAILED: Training data preprocessing failed. SYSTEM_TRAIN_DATA_PREPROCESS_SUCCESS: Training data preprocessed. SYSTEM_TRAINING: Training started. ADMIN_STOP_TRAIN: Training manually terminated. SYSTEM_TRAIN_FAILED: Training failed. SYSTEM_TRAIN_SUCCESS: Training succeeded. SYSTEM_INFERENCE_DATA_PREPROCESSING: Preprocessing inference data. SYSTEM_INFERENCE_DATA_PREPROCESS_FAILED: Inference data preprocessing failed. SYSTEM_INFERENCE_DATA_PREPROCESS_SUCCESS: Inference data preprocessed. SYSTEM_JOB_SUCCESS: Task completed. SYSTEM_MARKABLE_VIDEO: Identifies a video generation task. SYSTEM_MASK_VERIFY_VIDEO: Verifies a video generation task. SYSTEM_MASK_VERIFY_VIDEO_SUCCESS: Video generation task verified. SYSTEM_MASK_VERIFY_VIDEO_FAILED: Video generation task verification failed. SYSTEM_MARKABLE_VIDEO_SUCCESS: Video generation task identified. SYSTEM_MARKABLE_VIDEO_FAILED: Video generation task identification failed. SYSTEM_MASK_VIDEO_AND_ACTION_TIME_SUCCESS: Auto identified. SYSTEM_MASK_VIDEO_AND_ACTION_TIME_FAILED: Auto identification failed. ADMIN_MASK_UPLOADED: Mask file uploaded. ADMIN_UPDATE_VIDEO: Video replacement by administrator. USER_UPDATE_VIDEO: Video update by users. ADMIN_MASK_ACTION_TIME: Calibration by administrator.
log_description	String	Log description, covering review comments if the manual review failed and error messages reported by the DHTS and DHPS.
operate_user	String	Operators. Options: USER ADMIN SYSTEM

**Table 6** CommentLogInfo
Parameter	Type	Description
operate_time	String	Operation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
comment_type	String	USER_REJECT: Rejection by user. USER_COMMENT: User comments. ADMIN_COMMENT: Administrator's reply.
comment_title	String	Title.
comment_message	String	Message.
attachment_download_url	Array of strings	URL for downloading the attachment.

**Table 7** InferenceVideoMarkInfo
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.

**Table 8** InferenceActionMarkInfo
Parameter	Type	Description
action_info	Array of ActionMarkItem objects	Actions.

**Table 9** ActionMarkItem
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: SILENCE ACTION

**Table 10** InferenceEyeCorrectionMarkInfo
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.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

https://aaa.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://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?param1=XXX&param2=YYY",
  "create_time" : "2023-12-09T07:31:37Z",
  "contact" : "1**********",
  "model_version" : "V3",
  "matting_type" : "AI",
  "model_resolution" : "1080P",
  "training_video_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_trainingVideo?param1=XXX&param2=YYY",
  "id_card_image1_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage1?param1=XXX&param2=YYY",
  "id_card_image2_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage2?param1=XXX&param2=YYY",
  "grant_file_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_grantFile?param1=XXX&param2=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://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_markableData?param1=XXX&param2=YYY",
  "is_background_replacement" : true
}

Status code: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 500

{
  "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.