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

查询数字人智能交互任务

功能介绍

该接口用于查询数字人智能交互任务。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs/{job_id}/state

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

room_id

String

智能交互对话ID,获取方法请参考创建智能交互对话直播间

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表4 响应Body参数

参数

参数类型

描述

job_id

String

数字人智能交互对话任务ID。

state

String

数字人智能交互对话任务的状态。

  • WAITING: 等待

  • PROCESSING: 处理中

  • SUCCEED: 成功

  • FAILED: 失败

  • CANCELED: 取消

  • HEARTBEAT: 心跳

duration

Float

数字人智能交互对话时长,单位秒。

取值范围:

0-2147483647

start_time

String

数字人智能交互对话任务开始时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

end_time

String

数字人智能交互对话任务结束时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

error_info

ErrorResponse object

数字人智能交互对话任务出错信息。

create_time

String

数字人智能交互对话任务创建时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

lastupdate_time

String

数字人智能交互对话任务最后更新时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

rtc_room_info

RTCRoomInfoList object

RTC房间信息。

chat_subtitle_config

SmartChatSubtitleConfig object

对话字幕配置

video_config

SmartChatVideoConfig object

视频输出配置。

voice_config_list

Array of SmartChatVoiceConfig objects

语音配置参数列表。

chat_state

Integer

数字人智能交互对话的状态。

0: 等待建链

1: 等待关闭链路

2: 建链成功

3: 进入休眠

4: 等待休眠

取值范围:

0-32

language

String

智能交互语言

  • zh_CN:简体中文(已下线,请使用CN)

  • en_US:英语(已下线,请使用EN)

  • CN:中文

  • EN:英文

chat_video_type

String

智能交互对话端配置。

  • COMPUTER: 电脑端

  • MOBILE: 手机端

  • HUB: 大屏

chat_access_address

String

智能交互接入地址。

is_transparent

Boolean

是否透明背景

默认取值:

false

default_language

String

默认语言,智能交互接口使用。默认值CN。

  • CN:中文。

  • EN:英文。

默认取值:

CN

表5 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

表6 RTCRoomInfoList

参数

参数类型

描述

app_id

String

RTC应用ID。

room_id

String

RTC房间ID。

users

Array of RTCUserInfo objects

加入RTC房间用户信息。

表7 RTCUserInfo

参数

参数类型

描述

user_type

String

用户类型。

  • CAPTURE: 直播助手,将摄像头获取视频流推送到RTC房间

  • ANIMATION: VDS服务,从RTC房间拉视频流生成动作数据

  • RENDER: 渲染服务,将动作数据渲染成数字人动画

  • PLAYER: 普通观看方,可选择原始视频流或者数字人动画视频流观看

  • INFERENCE_USER: 数字人推理端用户。从RTC房间接收音频流,并推送视频流到RTC房间

  • END_USER: 端侧用户。从推送音频流到RTC房间,并从RTC房间接收视频流

user_id

String

RTC用户ID。

signature

String

RTC鉴权token。

ctime

Long

有效期。时间戳,单位:秒。

取值范围:

0-4294967295

表8 SmartChatSubtitleConfig

参数

参数类型

描述

dx

Integer

字幕左上角像素点坐标。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

取值范围:

0-1920

dy

Integer

字幕左上角像素点坐标。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

取值范围:

0-1920

width

Integer

图层图片宽度像素值(相对画布大小)。

说明:

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

取值范围:

1-7680

height

Integer

图层图片高度像素值(相对画布大小)。

说明:

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

取值范围:

1-7680

表9 SmartChatVideoConfig

参数

参数类型

描述

width

Integer

视频宽度。

单位:像素。

最小值320,最大值2560。

说明:
  • clip_mode=RESIZE时,当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率。4K分辨率视频需要分身数字人模型支持4K的情况下才能使用。

  • clip_mode=CROP,裁剪后视频,(dx,dy)为原点,保留视频像宽度为width。

  • 分身数字人直播目前只支持1080x1920。

取值范围:

0-3840

height

Integer

视频高度。

单位:像素。

最小值320,最大值2560。

说明:
  • clip_mode=RESIZE时,当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率分辨率。

  • clip_mode=CROP,裁剪后视频,(dx,dy)为原点,保留视频像高度为height。

  • 分身数字人直播目前只支持1080x1920。

取值范围:

0-3840

表10 SmartChatVoiceConfig

参数

参数类型

描述

voice_asset_id

String

语音合成特征字符串

speed

Integer

语速。默认值100,最小值50,最大值200。

说明:

当取值为“100”时,表示一个成年人正常的语速,约为250字/分钟。

取值范围:

50-200

默认取值:

100

pitch

Integer

音高。默认值100,最小值50,最大值200。

取值范围:

50-200

默认取值:

100

volume

Integer

音量。默认值140,最小值90,最大值240。

取值范围:

90-240

默认取值:

140

provider

String

第三方TTS供应商类型。

  • XIMALAYA:喜马拉雅TTS

  • HUAWEI_EI:EI TTS

  • MOBVOI:出门问问TTS

language

String

语言类型。默认值CN。

  • CN:中文。

  • EN:英文。

默认取值:

CN

language_desc

String

语言描述。

状态码: 400

表11 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

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

请求示例

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/smart-chat-rooms/41c86xxxxxx34253850af102cdxxxxxx/smart-chat-jobs/38ch6xxxxxx5z233850af709crxxxxxx/state

响应示例

状态码: 200

处理成功返回。

{
  "job_id" : "38ch6xxxxxx5z233850af709crxxxxxx",
  "state" : "WAITING",
  "start_time" : "2023-01-18T16:29:36Z",
  "end_time" : "2023-01-18T16:30:36Z",
  "duration" : 60,
  "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
  },
  "chat_state" : 0,
  "chat_access_address" : "xxx.xxx.xxx.xxx:443"
}

状态码: 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
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 ShowSmartChatJobSolution {

    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();
        ShowSmartChatJobRequest request = new ShowSmartChatJobRequest();
        request.withRoomId("{room_id}");
        request.withJobId("{job_id}");
        try {
            ShowSmartChatJobResponse response = client.showSmartChatJob(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 = ShowSmartChatJobRequest()
        request.room_id = "{room_id}"
        request.job_id = "{job_id}"
        response = client.show_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
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.ShowSmartChatJobRequest{}
	request.RoomId = "{room_id}"
	request.JobId = "{job_id}"
	response, err := client.ShowSmartChatJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码

相关文档