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

事件通知(EventMap)

本节介绍Web SDK的EventMap事件。

表1 通知列表

接口

描述

error

错误事件。

enterSleep

数字人自动休眠事件。

jobInfoChange

交互任务信息变更事件。

speakingStart

数字人开始讲话事件。

speakingStop

数字人结束讲话事件。

speechRecognized

ASR对提问进行语音识别后输出为文本的事件。

semanticRecognized

LLM对提问进行语义识别后输出回复文本的事件。speechRecognized和semanticRecognized分别为问题和答案,每轮问答共用一个chatId。

error

事件说明

在业务异常时,返回的错误事件。

回调参数

icsError:IcsError类型。字段定义如表2所示。
表2 IcsError

参数

类型

描述

code

string

错误码。详情请参见错误码(ICSError)

message

string

错误信息。

enterSleep

事件说明

数字人自动休眠事件。

回调参数

无。

jobInfoChange

事件说明

变更交互任务信息的事件。交互任务状态发生变化时,会通知使用方。如果交互任务就绪,jobInfo中的jobId为进行中的任务ID,否则jobId为空字符串。

回调参数

jobInfo:JobInfo类型。字段定义如表3所示。

表3 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。

isReady

boolean

任务是否就绪。

speakingStart

事件说明

数字人开始讲话的事件。

回调参数

无。

speakingStop

事件说明

数字人结束讲话的事件。

回调参数

无。

speechRecognized

事件说明

ASR对提问进行语音识别后输出为文本的事件。

回调参数

question:SpeechRecognitionInfo类型。字段定义如表4所示。

表4 SpeechRecognitionInfo

参数

类型

描述

text

string

识别结果文本。

resultId

number

识别流式响应时返回的各包顺序序号。

isLast

boolean

是否是最后一条识别结果。

chatId

string

对话ID,每轮问答的ID值唯一。

speechRecognized通知的流式返回跟semanticRecognized是有差异的,详细见:speechRecognized和semanticRecognized通知的流式返回有什么差异?

semanticRecognized

事件说明

LLM对提问进行语义识别后输出回复文本的事件。speechRecognized和semanticRecognized分别为问题和答案,每轮问答共用一个chatId。

回调参数

answer:SemanticRecognitionInfo类型。字段定义如表5所示。

表5 SemanticRecognitionInfo

参数

类型

描述

text

string

识别结果文本。

questionText

string

问题文本。

resultId

number

识别流式响应时返回的各包顺序序号。

isLast

boolean

是否是最后一条识别结果。

chatId

string

对话ID,每轮问答的ID值唯一。

semanticRecognized通知的流式返回跟speechRecognized是有差异的,详细见:speechRecognized和semanticRecognized通知的流式返回有什么差异?