启动数字人智能交互任务
功能介绍
该接口用于启动数字人智能交互任务。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
room_id |
是 |
String |
智能交互对话ID,获取方法请参考创建智能交互对话直播间。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
robot_id |
是 |
String |
应用ID,获取方法请参考创建应用。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
智能交互对话任务ID。 |
language |
String |
智能交互语言
|
rtc_room_info |
RTCRoomInfoList object |
RTC房间信息。 |
chat_subtitle_config |
ChatSubtitleConfig object |
对话字幕配置 |
video_config |
ChatVideoConfigRsp object |
视频输出配置。 |
chat_video_type |
String |
智能交互对话端配置。
|
参数 |
参数类型 |
描述 |
---|---|---|
app_id |
String |
RTC应用ID。 |
room_id |
String |
RTC房间ID。 |
users |
Array of RTCUserInfo objects |
加入RTC房间用户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_type |
String |
用户类型。
|
user_id |
String |
RTC用户ID。 |
signature |
String |
RTC鉴权token。 |
ctime |
Long |
有效期。时间戳,单位:秒。 |
参数 |
参数类型 |
描述 |
---|---|---|
dx |
Integer |
字幕左上角像素点坐标。 说明:
*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。 |
dy |
Integer |
字幕左上角像素点坐标。 说明:
*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。 |
width |
Integer |
图层图片宽度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
height |
Integer |
图层图片高度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
参数 |
参数类型 |
描述 |
---|---|---|
width |
Integer |
视频宽度。 单位:像素。 最小值320,最大值2560。 说明:
|
height |
Integer |
视频高度。 单位:像素。 最小值320,最大值2560。 说明:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/smart-chat-rooms/41c86xxxxxx34253850af102cdxxxxxx/smart-chat-jobs?robot_id=4d54xxxxxxc446249xxxxxxxxxx6526
响应示例
状态码: 200
处理成功返回。
{ "job_id" : "38ch6xxxxxx5z233850af709crxxxxxx", "rtc_room_info" : { "app_id" : "8cb83827a73d4d4f8191eae56bfea550", "room_id" : "41c86xxxxxx34253850af102cdxxxxxx", "users" : [ { "user_type" : "PLAYER", "user_id" : "eca4e308c4ed49f0b3822e5de33b34b6", "signature" : "83090ff53f3040xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxf4cb21585b781", "ctime" : 1702866202 } ] }, "chat_subtitle_config" : { "dx" : 256, "dy" : 256, "width" : 256, "height" : 256 }, "video_config" : { "width" : 1920, "height" : 1080 } }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
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 |
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 StartSmartChatJobSolution { 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(); StartSmartChatJobRequest request = new StartSmartChatJobRequest(); request.withRoomId("{room_id}"); try { StartSmartChatJobResponse response = client.startSmartChatJob(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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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 = StartSmartChatJobRequest() request.room_id = "{room_id}" response = client.start_smart_chat_job(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 |
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.StartSmartChatJobRequest{} request.RoomId = "{room_id}" response, err := client.StartSmartChatJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
请求传参异常,包含错误码及对应描述。 |
错误码
请参见错误码。