更新时间:2024-11-18 GMT+08:00
分享

创建语音驱动任务

功能介绍

该接口用于创建驱动数字人表情、动作及语音的任务。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/ttsa-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

表3 请求Body参数

参数

是否必选

参数类型

描述

voice_asset_id

String

音色模型ID。需要使用MetaStudio的数字资产管理相关接口从资产库查出。

script_type

String

脚本类型,即视频制作的驱动方式。默认TEXT

  • TEXT: 文本驱动,即通过TTS合成语音

  • AUDIO: 语音驱动

默认取值:

TEXT

text

String

HTML格式的台词,可包含动作。最多2048个字符。

说明:
  • HTML格式举例:<speak>大家好<insert-action id="14cc7bbcde4982aab82f9d9af9e0f743"/>,非常高兴给大家介绍MetaStudio。</speak>

  • insert-action id通过查询资产列表接口获取,查询时asset_type=ANIMATION

  • 多音字标签:<phoneme ph="拼音">汉字</phoneme>,南京<phoneme ph="shi4 zhang3">市长</phoneme>江大桥。

  • 停顿标签:<break/>,中方一贯主张<break/>维护国家主权平等,不干涉他国内政<break time="300ms"/>是联合国宪章<break time="500ms"/>最重要的原则。

audio_file_download_url

String

语音驱动音频文件下载URL。

speed

Integer

语速。

取值范围[50,200]

默认值:100

取值范围:

50-200

默认取值:

100

pitch

Integer

基频。

取值范围[50,200]

默认值:100

取值范围:

50-200

默认取值:

100

volume

Integer

音量。

取值范围[90,240]

默认值:100

取值范围:

90-240

默认取值:

140

emotion

String

情感标签。

  • ANGER:愤怒

  • HAPPY:开心

  • SAD:悲伤

  • CALM:平静

style_id

String

风格化ID。需要调用数字人风格管理相关接口,从系统中查得。

camera_position

String

人位置及相机位置。由如下4组浮点数组成的字符:人位置的X/Y/Z值,人角度的Pitch/Yaw/Roll值;相机位置的X/Y/Z值,相机角度的Pitch/Yaw/Roll值。

job_type

String

任务类型。

  • REAL_JOB:实时任务。如数字人交互。

  • UNREAL_JOB:非实时任务。如数字人视频制作

默认取值:

REAL_JOB

响应参数

状态码: 202

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

请求传参异常,包含错误码及对应描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

InternalServiceError

AnyType

内部服务错误。

请求示例

POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/ttsa-jobs

{
  "speed" : 100,
  "voice_asset_id" : "d05b8edc4b8d189973c1735207ee1505",
  "volume" : 100,
  "auto_motion" : false,
  "script_type" : "TEXT",
  "text" : "测试用朗读文本。",
  "pitch" : 100,
  "style_id" : "262228a233820e80d99c4a223615e9a5"
}

响应示例

状态码: 202

处理成功返回。

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

状态码: 400

请求传参异常,包含错误码及对应描述。

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

状态码: 500

内部服务错误。

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class CreateTtsaSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateTtsaRequest request = new CreateTtsaRequest();
        CreateTTSAReq body = new CreateTTSAReq();
        body.withStyleId("262228a233820e80d99c4a223615e9a5");
        body.withVolume(100);
        body.withPitch(100);
        body.withSpeed(100);
        body.withText("测试用朗读文本。");
        body.withScriptType(CreateTTSAReq.ScriptTypeEnum.fromValue("TEXT"));
        body.withVoiceAssetId("d05b8edc4b8d189973c1735207ee1505");
        request.withBody(body);
        try {
            CreateTtsaResponse response = client.createTtsa(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateTtsaRequest()
        request.body = CreateTTSAReq(
            style_id="262228a233820e80d99c4a223615e9a5",
            volume=100,
            pitch=100,
            speed=100,
            text="测试用朗读文本。",
            script_type="TEXT",
            voice_asset_id="d05b8edc4b8d189973c1735207ee1505"
        )
        response = client.create_ttsa(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateTtsaRequest{}
	volumeCreateTtsaReq:= int32(100)
	pitchCreateTtsaReq:= int32(100)
	speedCreateTtsaReq:= int32(100)
	textCreateTtsaReq:= "测试用朗读文本。"
	scriptTypeCreateTtsaReq:= model.GetCreateTtsaReqScriptTypeEnum().TEXT
	request.Body = &model.CreateTtsaReq{
		StyleId: "262228a233820e80d99c4a223615e9a5",
		Volume: &volumeCreateTtsaReq,
		Pitch: &pitchCreateTtsaReq,
		Speed: &speedCreateTtsaReq,
		Text: &textCreateTtsaReq,
		ScriptType: &scriptTypeCreateTtsaReq,
		VoiceAssetId: "d05b8edc4b8d189973c1735207ee1505",
	}
	response, err := client.CreateTtsa(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

处理成功返回。

400

请求传参异常,包含错误码及对应描述。

500

内部服务错误。

错误码

请参见错误码

相关文档