创建数字人名片制作
功能介绍
该接口用于数字人名片制作任务。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/digital-human-business-cards
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。不允许输入中文。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
business_card_type |
是 |
String |
数字人名片类型。
|
card_templet_asset_id |
是 |
String |
数字人名片模板资产ID,可以从资产库中查询。 |
card_text_config |
是 |
BusinessCardTextConfig object |
用户输入的数字人名片信息。实际可以填写哪些字段取决于名片模板。 |
card_image_config |
是 |
BusinessCardImageConfig object |
用户上传的用于制作数字人名片的图片。 |
introduction_type |
否 |
String |
自我介绍驱动方式。
默认取值: TEXT |
introduction_text |
否 |
String |
自我介绍文本,用于驱动数字人口型。 |
voice_asset_id |
否 |
String |
音色资产ID,可以从资产库中查询。 |
introduction_audio_asset_id |
否 |
String |
自我介绍语音资产ID,用于驱动数字人口型。
说明:
|
video_asset_name |
否 |
String |
输出名片视频资产名称。默认取card_name的值 |
gender |
否 |
String |
性别。
|
review_config |
否 |
ReviewConfig object |
内容审核配置 |
callback_config |
否 |
CallBackConfig object |
回调设置。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
姓名。 |
company |
否 |
String |
企业或组织名称。 |
title |
否 |
String |
职位名称。 |
mobile_phone |
否 |
String |
手机号码。 |
phone |
否 |
String |
固话号码。 |
|
否 |
String |
电子邮件地址。 |
address |
否 |
String |
地址。 |
other1 |
否 |
String |
其他信息1。可填写一些公司广告语等 |
other2 |
否 |
String |
其他信息2。可填写一些公司广告语等 |
other3 |
否 |
String |
其他信息3。可填写一些公司广告语等 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
human_image |
是 |
String |
人物照片,需要Base64编码。 |
logo_image |
否 |
String |
Logo图片,需要Base64编码。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
callback_url |
是 |
String |
回调URL。 回调请求body为json格式,带参数如下: result: SUCCEED或FAILED asset_id: 资产ID job_id: 任务 |
auth_type |
否 |
String |
认证类型。
默认取值: NONE |
key |
否 |
String |
密钥Key |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
BadRequest |
AnyType |
请求传参异常,包含错误码及对应描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
Unauthorized |
AnyType |
未鉴权或鉴权失败。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
InternalServiceError |
AnyType |
内部服务错误。 |
请求示例
POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-business-cards
响应示例
状态码: 200
处理成功返回。
{ "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66" }
状态码: 400
请求传参异常,包含错误码及对应描述。
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
未鉴权或鉴权失败。
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 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 |
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 CreateDigitalHumanBusinessCardSolution { 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(); CreateDigitalHumanBusinessCardRequest request = new CreateDigitalHumanBusinessCardRequest(); CreateDigitalHumanBusinessCardReq body = new CreateDigitalHumanBusinessCardReq(); request.withBody(body); try { CreateDigitalHumanBusinessCardResponse response = client.createDigitalHumanBusinessCard(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 |
# 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 = CreateDigitalHumanBusinessCardRequest() request.body = CreateDigitalHumanBusinessCardReq( ) response = client.create_digital_human_business_card(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 |
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.CreateDigitalHumanBusinessCardRequest{} request.Body = &model.CreateDigitalHumanBusinessCardReq{ } response, err := client.CreateDigitalHumanBusinessCard(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。