网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

主入口(HwICSUiSdk)

更新时间:2025-01-15 GMT+08:00
分享

本节介绍Web SDK的接口详情。

表1 接口

接口

描述

三方驱动场景(是否支持)

非三方驱动场景(是否支持)

activeInteractionMode

获取当前生效的交互模式(语音问答/文本问答)。

×

addEventListeners

回调注册。

checkBrowserSupport

检查浏览器是否支持。

create

创建交互任务。

destroy

销毁交互任务。

getJobInfo

获取交互任务信息。

initResourcePath

初始化语音唤醒资源,不使用语音唤醒能力则忽略该接口。

×

interactionModeSwitch

切换交互模式(语音问答/文本问答)。

×

interruptSpeaking

中断数字人讲话。

×

muteRemoteAudio

数字人静音。

sendDrivenText

发送智能交互数字人主动播报的文本信息。

×

sendTextQuestion

发送问题文本。

×

setConfig

更新配置项。

setLogLevel

设置日志级别。

startChat

开始对话。

×

startSpeak

开始说话(注:接口已重命名为startUserSpeak,请直接切换至新接口)。

×

startUserSpeak

用户开始提问。

×

stopChat

结束对话。

×

stopSpeak

停止说话(注:接口已重命名为stopUserSpeak,请直接切换至新接口)。

×

stopUserSpeak

用户停止提问(注:此处只是停止ASR接收用户语音,对话仍处于激活态)。

×

unmuteRemoteAudio

数字人取消静音。

activeInteractionMode

(static) activeInteractionMode(): Promise<InteractionModeResult>

功能说明

获取当前生效的交互模式(语音问答/文本问答)。

请求参数

无。

返回参数

表2 InteractionModeResult

参数

类型

描述

result

boolean

执行结果。

errorCode

string | undefined

错误码,详细见表1

errorMsg

string | undefined

错误信息。

interactionMode

'AUDIO' | 'TEXT'

交互模式。

代码示例

const { result, interactionMode } = await HwICSUiSdk.activeInteractionMode();

addEventListeners

(static) addEventListeners(eventMap: EventMap): void

功能说明

设置事件回调。

请求参数

表3 eventMap

参数

是否必须

默认值

类型

描述

eventMap

-

EventMap

事件注册Map,请参见表4

表4 EventMap

参数

是否必须

默认值

类型

描述

error

-

(icsError: IcsError) => any

错误事件。

jobInfoChange

-

(jobInfo: JobInfo) => any

交互任务信息变更事件。

speakingStart

-

() => any

数字人开始讲话事件。

speakingStop

-

() => any

数字人结束讲话事件。

speechRecognized

-

(question: SpeechRecognitionInfo) => any

语音识别结果。

semanticRecognized

-

(answer: SemanticRecognitionInfo) => any

语义识别结果。

返回参数

代码示例

HwICSUiSdk.addEventListeners({
  error: (icsError) => {
    console.error('icsError', icsError);
  },
  jobInfoChange: (jobInfo) => {
    console.info('jobInfoChange', jobInfo);
  } 
});

checkBrowserSupport

(static) checkBrowserSupport(): Promise<boolean>

功能说明

检查当前浏览器是否支持运行SDK。

请求参数

返回参数

Promise<boolean>:当前浏览器是否支持运行SDK。

代码示例

1
2
3
4
5
6
const result = await HwICSUiSdk.checkBrowserSupport();
if (result) {
  // 支持
} else {
  // 不支持
}

create

(static) create(param: CreateParam): Promise<void>

功能说明

通过获取的任务链接和一次性鉴权码,创建智能交互任务。

请求参数

表5 param

参数

是否必选

默认值

类型

描述

param

-

CreateParam

创建活动选项,请参见表6

表6 CreateParam

参数

是否必选

默认值

类型

描述

onceCode

-

string

一次性鉴权码,获取方式请参见创建一次性鉴权码

说明:

CreateOnceCode接口需要在后台调用,不能在浏览器直接调用,否则有跨域问题。

serverAddress

-

string

智能交互服务端地址。

不同Region的取值如下所示:

  • 华北-北京四:metastudio-api.cn-north-4.myhuaweicloud.com
  • 华东-上海一:metastudio-api.cn-east-3.myhuaweicloud.com

robotId

-

string

智能交互活动ID,为参数“taskUrl”取值URL中携带的robot_id参数的值。

示例,如果URL为“https://metastudio-api.cn-north-4.myhuaweicloud.com/icswebclient?robot_id=a1b2c3d4e5f6”,则robotId值为a1b2c3d4e5f6

注意:robotId和taskUrl必须至少设置一个参数。

taskUrl

-

string

在MetaStudio控制台创建生成的数字人互动任务页面URL。URL获取方式,请参见创建智能交互数字人

注意:robotId和taskUrl必须至少设置一个参数。

containerId

-

string

渲染SDK交互界面UI的DOM节点ID。

config

-

ConfigMap

配置信息,请参见表14

eventListeners

-

EventMap

事件注册Map,请参见表4

第三方驱动的智能交互场景,必须传本参数。

logLevel

info

string

日志级别。

取值如下所示:

  • debug
  • info
  • warn
  • error
  • none

返回参数

代码示例

HwICSUiSdk.create({
  serverAddress: 'serverAddress',
  onceCode: 'onceCode',
  robotId: 'robotId',
  containerId: 'ics-root',
  logLevel: 'debug',
  config: {
    enableCaption: true,
    enableChatBtn: false
  },
  eventListeners: {
    error: (error) => {
      console.error('sdk error', {
        message: error.message,
        code: error.code,
      }, error);
    }
  }
});

destroy

(static) destroy(): Promise<void>

功能说明

销毁交互任务。

请求参数

返回参数

代码示例

HwICSUiSdk.destroy();

getJobInfo

(static) getJobInfo(): Promise<JobInfo>

功能说明

获取交互任务信息。

请求参数

返回参数

表7 JobInfo

参数

类型

描述

jobId

string

任务ID。

websocketAddr

string | undefined

智能交互服务端websocket地址,三方驱动场景用来拼接websocket链接。

须知:

参数返回的地址默认无wss://前缀,实际使用时,需要补齐前缀。示例:如果返回字段内容为metastudio-api.cn-north-4.myhuaweicloud.com:443,则需要拼接为wss://metastudio-api.cn-north-4.myhuaweicloud.com:443。

代码示例

const jobInfo = await HwICSUiSdk.getJobInfo();

initResourcePath

(static) interactionModeSwitch(param: ResourcePath): Promise<void>

功能说明

初始化语音唤醒资源,不使用语音唤醒能力则忽略该接口。

3.0.1之后的websdk包里面有如下两个资源文件,如果不使用语音唤醒,可忽略这两个文件。

  • wasmData.js:语音唤醒的算法资源文件。
  • modelData.js:语音唤醒的模型资源文件。

SDK内置默认唤醒模型,支持定制唤醒词,并更新本地模型,详见Web语音唤醒

请求参数

表8 ResourcePath

参数

是否必选

默认值

类型

描述

wasmPath

'wasmData.js'

string

唤醒算法资源文件的相对路径或者绝对路径。

  • 相对路径为基于当前页面的路径,比如:页面地址为https://.../a/b,默认值为'wasmData.js',则算法可执行文件路径为https://.../a/b/wasmData.js。

    需要确保该路径为websdk包内部wasmData.js文件。

  • 绝对路径为完整的HTTP文件资源路径。

dataPath

'modelData.js'

string

唤醒模型资源文件的相对路径或者绝对路径。

  • 相对路径为基于当前页面的路径,比如:页面地址为https://.../a/b,默认值为'modelData.js',则算法可执行文件路径为https://.../a/b/modelData.js。
  • 绝对路径为完整的HTTP文件资源路径。

initModel

true

boolean

是否直接初始化唤醒模型。

初始化唤醒模型需要2~3s的加载时间,这段时间无法进行其他操作,所以需要根据实际情况选择模型初始化的时间点,详细说明如下所示:

  • 如果为true,会在接口执行时,初始化模型。
  • 如果为false,会在数字人创建过程中,初始化模型。

返回参数

无。

代码示例

await HwICSUiSdk.initResourcePath({
  wasmPath: 'wasmData.js',
  dataPath: 'modelData.js',
  initModel: true,
});

注意:如果未设置wasmPath和dataPath或设置的不对,会报类似下面的异常。

此时语音唤醒是无法正常使用的,需要将路径设置为正确的才行。

图1 异常报错

interactionModeSwitch

(static) interactionModeSwitch(param: InteractionModeParam): Promise<InteractionModeResult>

功能说明

切换交互模式(语音问答/文本问答)。

请求参数

表9 InteractionModeParam

参数

是否必须

默认值

类型

描述

interactionMode

AUDIO

  • AUDIO
  • TEXT

交互模式,语音交互还是文本交互。

返回参数

见:表2

代码示例

const { result } = await HwICSUiSdk.interactionModeSwitch({ interactionMode: 'AUDIO' });

interruptSpeaking

(static) interruptSpeaking(): Promise<UISdkResult>

功能说明

中断数字人讲话。

请求参数

返回参数

请参见表18

代码示例

const { result } = await HwICSUiSdk.interruptSpeaking();

muteRemoteAudio

(static) muteRemoteAudio(): Promise<boolean>

功能说明

数字人静音。

请求参数

返回参数

Promise<boolean>:数字人静音是否成功。

代码示例

const result = await HwICSUiSdk.muteRemoteAudio();

sendDrivenText

(static) sendDrivenText(param: TextDrivenParam): Promise<ChatResult>

功能说明

发送智能交互数字人主动播报的文本信息。

注意:主动播报结束时的最后一次调用,一定要传“isLast:true”参数,否则数字人讲话结束时无法及时收到speakingStop通知。

请求参数

表10 TextDrivenParam

参数

是否必须

默认值

类型

描述

text

""

string

智能交互数字人主动播报的文本信息。

isLast

false

boolean

是否是最后一条。

返回参数

请参见表17

代码示例

const { result } = await HwICSUiSdk.sendDrivenText({ text: '你好', isLast: true });

sendTextQuestion

(static) sendTextQuestion(param: TextQuestionParam): Promise<TextQuestionResult>

功能说明

发送问题文本。

请求参数

表11 TextQuestionParam

参数

是否必须

默认值

类型

描述

text

-

string

问题文本。

返回参数

表12 TextQuestionResult

参数

类型

描述

result

boolean

执行结果。

errorCode

string | undefined

错误码,详细见表1

errorMsg

string | undefined

错误信息。

chatId

string

对话id。

代码示例

const { result } = await HwICSUiSdk.sendTextQuestion({ text: '你是谁' });

setConfig

(static) setConfig(config: ConfigMap): void

功能说明

设置配置项,用于控制是否显示字幕或交互按钮。

请求参数

表13 config

参数

是否必须

默认值

类型

描述

config

-

ConfigMap

配置信息,请参见表14

表14 ConfigMap

参数

是否必须

默认值

类型

描述

enableCaption

false

boolean

是否显示字幕。

enableChatBtn

false

boolean

是否显示交互按钮。

enableHotIssues

false

boolean

是否显示热点问题。

enableWeakErrorInfo

true

boolean

是否显示弱提示。

示例:SDK内部websocket异常提示。

enableBusinessTrack

true

boolean

是否上报SDK埋点数据。

enableJobCache

true

boolean

是否启用任务缓存。如果用户希望每次修改任务配置后能快速生效,可不启用缓存。

  • 启用任务缓存,可加快数字人的启动速度。
  • 关闭任务缓存,每次调用create创建任务时,都会创建新任务,不使用上次缓存的任务。

useDefaultBackground

true

boolean

是否使用默认背景图。

enableLocalWakeup

false

boolean

是否启用语音唤醒能力。如果启动,需要先调用initResourcePath接口初始化唤醒资源路径,再调用create接口创建数字人。

返回参数

代码示例

HwICSUiSdk.setConfig({
  enableCaption: true,
  enableChatBtn: false,
  enableHotIssues: false,
  enableWeakErrorInfo: true,
});

setLogLevel

(static) setLogLevel(logLevel: 'debug' | 'info' | 'warn' | 'error' | 'none'): void

功能说明

设置输出日志的级别。

请求参数

表15 logLevel

参数

是否必须

默认值

类型

描述

logLevel

info

  • debug
  • info
  • warn
  • error
  • none

日志级别。

返回参数

代码示例

HwICSUiSdk.setLogLevel('warn');

startChat

(static) startChat(param?: ChatParam): Promise<ChatResult>

功能说明

开始对话。

请求参数

表16 ChatParam

参数

是否必须

默认值

类型

描述

interactionMode

AUDIO

  • AUDIO
  • TEXT

交互模式,语音交互还是文本交互。

返回参数

表17 ChatResult

参数

类型

描述

result

boolean

执行结果。

errorCode

string | undefined

错误码,详细见表1

errorMsg

string | undefined

错误信息。

chatId

string

对话id。

代码示例

const { result } = await HwICSUiSdk.startChat({ interactionMode: 'AUDIO' });

startSpeak

(static) startSpeak(): Promise<UISdkResult>

功能说明

开始说话。

请求参数

返回参数

请参见表18

代码示例

const { result } = await HwICSUiSdk.startSpeak();

startUserSpeak

(static) startUserSpeak(): Promise<UISdkResult>

功能说明

用户开始提问。

请求参数

返回参数

表18 UISdkResult

参数

类型

描述

result

boolean

执行结果。

errorCode

string | undefined

错误码,详细见表1

errorMsg

string | undefined

错误信息。

代码示例

const { result } = await HwICSUiSdk.startUserSpeak();

stopChat

(static) stopChat(): Promise<ChatResult>

功能说明

结束对话。

请求参数

返回参数

请参见表17

代码示例

const { result } = await HwICSUiSdk.stopChat();

stopSpeak

(static) stopSpeak(): Promise<UISdkResult>

功能说明

停止说话。

请求参数

返回参数

请参见表18

代码示例

const { result } = await HwICSUiSdk.stopSpeak();

stopUserSpeak

(static) stopUserSpeak(): Promise<UISdkResult>

功能说明

用户停止提问。

请求参数

返回参数

请参见表18

代码示例

const { result } = await HwICSUiSdk.stopUserSpeak();

unmuteRemoteAudio

(static) unmuteRemoteAudio(): Promise<boolean>

功能说明

数字人取消静音。

请求参数

返回参数

Promise<boolean>:数字人取消静音是否成功。

代码示例

const result = await HwICSUiSdk.unmuteRemoteAudio();
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容