Querying Voice Training Tasks

Function

Queries voice training tasks.

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}/voice-training-manage/user/jobs

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset where the query starts. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Number of items displayed on each page. Value range: 1~100 Default value: 10
create_until	No	String	Filter the records whose creation time is not later than the entered time.
create_since	No	String	Filter the records whose creation time is not earlier than the entered time.
update_until	No	String	Records whose update time is not later than the input time.
update_since	No	String	Records whose update time is not earlier than the input time.
state	No	String	Task status. By default, all statuses are selected. Multiple statuses can be queried. Use commas (,) to separate them, For example, state=FAILED,WAITING. Task status. Options: * CREATING: The task is being created. * SYSTEM_AUDITING: The task is being reviewed. * AUDITING: The task is being manually reviewed. * WAITING_SPLIT: The task is waiting for trimming. * SPLITTING: The trimming is in progress. * SPLIT_FAILED: The trimming failed. * ANNOTATING: The annotation is in progress. * WAITING: The task is waiting for training. * PROCESSING: The task is being trained. * RESULT_REVIEW: review result * AUDIT_FAILED: The review failed and the system waits for the user to upload data again. * UPLOADING: The file is being uploaded. * FAILED: failed. * SUCCEED: succeeded.
job_id	No	String	Task ID.
voice_name	No	String	Voice name.
tag	No	String	Task tag.
job_type	No	String	Training type. BASIC: basic edition (20 sentences) MIDDLE: advanced edition (100 sentences) ADVANCE: premium edition THIRD_PARTY: third-party DupDub THIRD_PARTY_LJZN: third-party AudioX FLEXUS: Flexus edition, using large model feature extraction
batch_name	No	String	Batch name.
sort_key	No	String	Sorting field. create_time and update_time are supported. Default value: create_time
sort_dir	No	String	Sorting rule. The options are desc (descending order) and asc (ascending order). Default value: desc
is_ondemand_resource	No	Boolean	Whether the task is on demand.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of tasks that meet the query criteria. Value range: 0~2147483647
jobs	Array of TrainingJobInfo objects	Virtual avatar model training tasks.

**Table 5** TrainingJobInfo
Parameter	Type	Description
job_type	String	Training type. BASIC: basic edition (20 sentences) MIDDLE: advanced edition (100 sentences) ADVANCE: premium edition THIRD_PARTY: third-party DupDub THIRD_PARTY_LJZN: third-party AudioX FLEXUS: Flexus edition, using large model feature extraction
job_id	String	Task ID.
app_user_id	String	User ID.
voice_name	String	Timbre name. The name is used as the name of the timbre model asset in the asset library.
sex	String	Gender. FEMALE MALE
language	String	Language.
state	String	Task status. CREATING: The task is being created. SYSTEM_AUDITING: The task is being reviewed by the system. AUDITING: The task is being manually reviewed. WAITING_SPLIT: The task is waiting for trimming. SPLITTING: The trimming is in progress. SPLIT_FAILED: The trimming failed. ANNOTATING: The annotation is in progress. WAITING: The task is waiting for training. PROCESSING: The task is being trained. RESULT_REVIEW: review result AUDIT_FAILED: The review failed and the system waits for the user to upload data again. UPLOADING: The file is being uploaded. FAILED: Task execution failed. SUCCEED: Task execution succeeded.
reject_times	Integer	Number of times that the status occurs in the current task. Value range: 1~10
asset_id	String	ID of the timbre model in the asset library. This parameter is displayed when the task status is successful.
job_failed_code	String	An error code is displayed when a task fails.
job_failed_reason	String	The failure cause is displayed when a task fails.
create_time	Long	Task creation time. Value range: 1~2147483647
lastupdate_time	Long	Time when the task status is updated. Value range: 1~2147483647
voice_authorization_url	String	Link to the user's authorization letter.
training_input_source_url	String	URL of the original input data.
create_type	String	Task creation mode. PACKAGE: A .zip file contains all data. SEGMENT: Data is uploaded sentence by sentence.
tag	String	Task tag. ECOMMERCE NEWS MARKETING LIVE: livestreaming EDUCATION: education and training CUSTOMER: customer service STORYTELLING: story telling
phone	String	Mobile phone number
dhtms_job_id	String	Image modeling task ID
batch_name	String	Batch name.
allocated_resource	VoiceTrainingAllocatedResource object
output_language	String	Language of the model output.
is_remake	Boolean	Whether to redo the task.
assess_result	AssessResult object	Audio quality assessment result.
is_ondemand_resource	Boolean	Whether the task is on demand. Default value: false

**Table 6** VoiceTrainingAllocatedResource
Parameter	Type	Description
resource_id	String	Resource ID.
charge_mode	String	Resource billing type. ON_DEMAND: pay-per-use billing. Currently, this billing mode is only applicable to the advanced edition, allowing a maximum of three tasks. PERIODIC: yearly/monthly billing ONE_TIME: one-off billing NOTE: One-off billing includes one-off resources purchased by tenants and those allocated by the SP administrator to tenants.
expire_time	String	Resource expiration time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

**Table 7** AssessResult
Parameter	Type	Description
speed	AssessProperty object	Assessment metric details.
sound	AssessProperty object	Assessment metric details.
snr	AssessProperty object	Assessment metric details.
reverb	AssessProperty object	Assessment metric details.
dnsmos_ovrl	AssessProperty object	Assessment metric details.
dnsmos_bak	AssessProperty object	Assessment metric details.
suggestion	String	Suggestions.

**Table 8** AssessProperty
Parameter	Type	Description
expected	String	Expected information.
actual	String	Actual information.
suggestion	String	Suggestions in Chinese.
suggestion_en	String	Suggestions in English.
status	Integer	Whether the range is exceeded. Value range: -1~1

Status code: 400

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

Example Requests

GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/voice-training-manage/user/jobs

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "count" : 2147483647,
  "jobs" : [ {
    "job_type" : "BASIC",
    "job_id" : "abcdefg",
    "app_user_id" : "123qwe",
    "voice_name" : "Female voice",
    "sex" : "FEMALE",
    "language" : "CN",
    "state" : "WAITING",
    "asset_id" : "my_asset_id",
    "job_failed_code" : "MSS.00000000",
    "job_failed_reason" : "error reason",
    "create_time" : 2147483647,
    "lastupdate_time" : 2147483647,
    "voice_authorization_url" : "https://bucket/data",
    "create_type" : "PACKAGE",
    "tag" : "ECOMMERCE"
  } ]
}